baseProjectTemplate

base fastapi, discord.py && svelte project template. with <3 by yxzhin ^^

features

• //@TODO

requirements

• docker
• uv
• pnpm

setup

1. clone the repository: git clone https://github.com/yxzhin/baseProjectTemplate; cd baseProjectTemplate
2. create python virtual environment && install the requirements: uv venv; uv sync
3. copy .env.example to .env && edit the secrets with yours
4. install the pre-commit hooks (done only once): uv run pre-commit install
5. (optional) import vscode profile: baseProjectTemplate.code-profile

run

1. run docker compose: docker compose up -d
2. in the first powershell instance, run the server: scripts\run-server && go to http://localhost:8000/api/test to test it
3. in the second one, run the bot: scripts\run-bot && use commands /ping && /api_test to test it
4. in the third one, run the client: scripts\run-client && go to http://localhost:5173/users to test it
5. it works!! 🎉

testing

• use uv run pytest to run server && bot tests

credits

• @Dimitrymas for some stuff
• @GrygoryZach && @GrujicFilipRS for inspiration && motivation <3