mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-30 04:15:45 +08:00
Xiaoyu SuandJunyan Chin
310c566148
* 重构文档结构：移除 docs 目录，调整文件组织结构 * Reorder "插件 SDK API" section in docs.json * Refactor and clarify various documentation sections * Refine warnings and info boxes across multiple docs * Refactor and simplify Japanese documentation content * Update package.json to include mintlify as a dependency and add pnpm-lock.yaml for dependency management * Update blog link and add description in docs.json --------- Co-authored-by: Junyan Chin <[email protected]>
73 lines
2.0 KiB
Plaintext
73 lines
2.0 KiB
Plaintext
---
|
|
title: "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 --dev
|
|
```
|
|
|
|
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
|
|
|
|
# If pnpm is not installed, you can also use npm to solve dependencies and start
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Then according to the output information, visit `http://127.0.0.1:3000` to view the standalone frontend page.
|
|
|
|
<Info title="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.
|
|
</Info>
|
|
|
|
## Code Formatting
|
|
|
|
The repository contains lint and format check workflows, and your code will be automatically checked when you push it. Please configure pre-commit to check your code locally before submitting.
|
|
|
|
```bash
|
|
uv run pre-commit install
|
|
```
|
|
|
|
## API Documentation
|
|
|
|
We will write API documentation in APIFox before developing each interface. Please refer to [API Documentation(Chinese)](https://ok52vhsenr.apifox.cn/).
|