vertex-backend/readme.md
2025-02-08 21:43:26 +08:00

45 lines
1.1 KiB
Markdown

# Project Vertex - Backend
The name `Vertex` is a misspell of word `vortex` (漩涡). But I just leave all the naming wrong as `Vertex`, it means `顶点`
## Project Setup
Ensure you have Miniconda or Anaconda installed on your machine, and is using a modern version of windows or linux.
The following command will install all the dependencies. Notice now we only have linux environment config, you need to manually install depds on windows.
```bash
conda create --name vertex -f ./env-linux.yml
conda activate vertex
```
After that, you can start the development server by running the following command.
```bash
python ./backend.py
```
By default it runs on 35000. Use `VERTEX_PORT` to specify the port.
```bash
VERTEX_PORT=8080 python ./backend.py
```
To build the project, run the following command.
```bash
pyinstaller ./backend.py
```
That will generate a `dist` folder, and you can find the executable file in the folder.
## Project Structure
WIP
## Author
By Dustella Chan (Hanwen Yu), distributed at my gitea server only.
Contact me at `dustella@yeah.net`