mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-30 12:25:29 +08:00
How-Sean XinandJunyan Qin
3676c0ab47
* Update dev-config.md update for windows * Update dev-config.md * Update dev-config.md * Update dev-config.md * perf: comments --------- Co-authored-by: Junyan Qin <[email protected]>
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# Development Configuration
|
|
|
|
LangBot is divided into frontend and backend. The frontend is developed using Next.js + shadcn, and the backend is developed using Quart (an asynchronous version of Flask).
|
|
|
|
## Backend
|
|
|
|
The code is located in the `pkg` directory and is started by the `main.py` file in the root directory.
|
|
|
|
Install dependencies, we use uv to manage dependencies.
|
|
|
|
```bash
|
|
pip install uv
|
|
uv sync
|
|
```
|
|
|
|
Start the backend
|
|
|
|
```bash
|
|
uv run main.py
|
|
```
|
|
|
|
At this point, the configuration file will be automatically generated in the `data/config.yaml` file.
|
|
|
|
## Frontend
|
|
|
|
The code is located in the `web` directory and requires Node.js and [pnpm](https://pnpm.io/installation).
|
|
|
|
Copy `.env.example` to `.env` and fill in the values.
|
|
|
|
- Usage in Linux and other environments
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
- Usage in Windows environments
|
|
|
|
```bash
|
|
copy .env.example .env
|
|
```
|
|
|
|
Install dependencies and start the frontend
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm dev
|
|
```
|
|
|
|
:::info
|
|
When using `pnpm dev` to start locally, the environment variable `NEXT_PUBLIC_API_BASE_URL` will be automatically used by the frontend to ensure that the frontend can access the `5300` port of the locally running backend.
|
|
|
|
In production environments, the frontend will be precompiled into static files and provided by the backend, and the frontend will automatically access the backend address on the same domain.
|
|
:::
|
|
|
|
## API Documentation
|
|
|
|
We will write API documentation in APIFox before developing each interface. Please refer to [API Documentation(Chinese)](https://ok52vhsenr.apifox.cn/).
|