📝 docs(CONTRIBUTING.md): update contributing guidelines and local development instructions
🚩GitHub Issues:
- Update heading level for GitHub Issues section to match the document structure
Issue labels:
- Update heading level for Issue labels section to match the document structure
Local development:
- Update heading level for Local development section to match the document structure
Run locally:
- Update heading level for Run locally section to match the document structure
- Add instructions for installing dependencies and starting the development server for the backend
- Add instructions for installing dependencies and starting the development server for the frontend
Docker compose:
- Update heading level for Docker compose section to match the document structure
- Add instructions for running the backend and frontend using Docker compose
Documentation:
- Update heading level for Documentation section to match the document structure
- Add instructions for running the documentation locally using Docusaurus
- Update the available URL for the documentation
Create a Pull Request:
- Add a closing statement with instructions to create a Pull Request to the `main` branch
This commit is contained in:
parent
92b99f82d9
commit
10ca88f709
1 changed files with 29 additions and 12 deletions
|
|
@ -9,7 +9,7 @@ Please do not try to push directly to this repo unless you are a maintainer.
|
|||
|
||||
## 🗺️Contributing Guidelines
|
||||
|
||||
### 🚩GitHub Issues
|
||||
## 🚩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
|
||||
|
|
@ -33,18 +33,19 @@ so that more people can benefit from it.
|
|||
[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
|
||||
## 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.
|
||||
|
||||
## Local development
|
||||
|
||||
### 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
|
||||
```
|
||||
|
|
@ -53,30 +54,46 @@ This will install the pre-commit hooks, which will run `make format` on every co
|
|||
|
||||
It is advised to run `make lint` before pushing to the repository.
|
||||
|
||||
#### **Locally**
|
||||
Run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system.
|
||||
## 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
|
||||
|
||||
For the backend, you will need to install the dependencies and start the development server.
|
||||
- Poetry (>=1.4)
|
||||
- Node.js
|
||||
|
||||
Then, in the root folder, install the dependencies and start the development server for the backend:
|
||||
|
||||
```bash
|
||||
make install_backend
|
||||
make backend
|
||||
```
|
||||
For the frontend, you will need to install the dependencies and start the development server.
|
||||
|
||||
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`.
|
||||
|
||||
#### **Docker compose**
|
||||
This 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
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation is built using [Docusaurus](https://docusaurus.io/). To run the documentation locally, run the following commands:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
npm install
|
||||
npm run start
|
||||
```
|
||||
|
||||
The documentation will be available at `localhost:3000` and all the files are located in the `docs/docs` folder.
|
||||
Once you are done with your changes, you can create a Pull Request to the `main` branch.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue