Skip to main content
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. 
pip install uv
uv sync --dev
Start the backend 
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. Copy .env.example to .env and fill in the values.
  • Usage in Linux and other environments
cp .env.example .env
  • Usage in Windows environments
copy .env.example .env
Install dependencies and start the frontend 
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.
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.

​
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. 
uv run pre-commit install

​
API Documentation

We will write API documentation in APIFox before developing each interface. Please refer to API Documentation(Chinese).