organized folders, added components tab, adjusted mendable style.

This commit is contained in:
carlosrcoelho 2023-06-26 19:17:12 -03:00
commit d76d5cd10c
77 changed files with 2291 additions and 11030 deletions

View file

@ -0,0 +1,38 @@
# Community
## 🤖 Join **LangFlow** Discord server
Join us to ask questions and showcase your projects.
Let's bring together the building blocks of AI integration!
LangFlow [Discord](https://discord.gg/EqksyE2EX9) server.
---
## 🐦 Stay tunned for **LangFlow** on Twitter
Follow [@logspace_ai](https://twitter.com/logspace_ai) on **Twitter** to get the latest news about **LangFlow**.
---
## ⭐️ Star **LangFlow** on GitHub
You can "star" **LangFlow** in [GitHub](https://github.com/logspace-ai/langflow).
By adding a star, other users will be able to find it more easily and see that it has been already useful for others.
---
## 👀 Watch the GitHub repository for releases
You can "watch" **LangFlow** in [GitHub](https://github.com/logspace-ai/langflow).
If you select "Watching" instead of "Releases only" you will receive notifications when someone creates a new issue or question. You can also specify that you only want to be notified about new issues, discussions, PRs, etc.
Then you can try and help them solve those questions.
---
Thanks! 🚀

View file

@ -0,0 +1,27 @@
# GitHub Issues
Our [issues](https://github.com/logspace-ai/langflow/issues) page is kept up to date
with bugs, improvements, and feature requests. There is a taxonomy of labels to help
with sorting and discovery of issues of interest.
If you're looking for help with your code, consider posting a question on the
[GitHub Discussions board](https://github.com/logspace-ai/langflow/discussions). Please
understand that we won't be able to provide individual support via email. We
also believe that help is much more valuable if it's **shared publicly**,
so that more people can benefit from it.
- **Describing your issue:** Try to provide as many details as possible. What
exactly goes wrong? _How_ is it failing? Is there an error?
"XY doesn't work" usually isn't that helpful for tracking down problems. Always
remember to include the code you ran and if possible, extract only the relevant
parts and don't just dump your entire script. This will make it easier for us to
reproduce the error.
- **Sharing long blocks of code or logs:** If you need to include long code,
logs or tracebacks, you can wrap them in `<details>` and `</details>`. This
[collapses the content](https://developer.mozilla.org/en/docs/Web/HTML/Element/details) so it only becomes visible on click, making the issue easier to read and follow.
## Issue labels
[See this page](https://github.com/logspace-ai/langflow/labels) for an overview of the system we use to tag our issues and pull requests.

View file

@ -0,0 +1,62 @@
# How to contribute?
👋 Hello there! We welcome contributions from developers of all levels to our open-source project on [GitHub](https://github.com/logspace-ai/langflow). If you'd like to contribute, please check our contributing guidelines and help make LangFlow more accessible.
As an open-source project in a rapidly developing field, we are extremely open
to contributions, whether in the form of a new feature, improved infra, or better documentation.
To contribute to this project, please follow a ["fork and pull request"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
Please do not try to push directly to this repo unless you are a maintainer.
---
## Local development
You can develop LangFlow using docker compose, or locally.
We provide a .vscode/launch.json file for debugging the backend in VSCode, which is a lot faster than using docker compose.
Setting up hooks:
```bash
make init
```
This will install the pre-commit hooks, which will run `make format` on every commit.
It is advised to run `make lint` before pushing to the repository.
---
## Run locally
LangFlow can run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system.
Before you start, make sure you have the following installed:
- Poetry (>=1.4)
- Node.js
Then install the dependencies and start the development server for the backend:
```bash
make install_backend
make backend
```
And the frontend:
```bash
make frontend
```
---
## Docker compose
The following snippet will run the backend and frontend in separate containers. The frontend will be available at `localhost:3000` and the backend at `localhost:7860`.
```bash
docker compose up --build
# or
make dev build=1
```