https://github.com/boblyx/blr-fastapi
Boilerplate for Fast API projects
https://github.com/boblyx/blr-fastapi
boilerplate fastapi fastapi-template
Last synced: 6 months ago
JSON representation
Boilerplate for Fast API projects
- Host: GitHub
- URL: https://github.com/boblyx/blr-fastapi
- Owner: boblyx
- Created: 2024-05-14T02:47:07.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T01:00:27.000Z (about 1 year ago)
- Last Synced: 2025-02-19T02:21:44.825Z (about 1 year ago)
- Topics: boilerplate, fastapi, fastapi-template
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fast API Boilerplate
- This repo contains boilerplate setup for FastAPI applications.
- Describe solution here
## Development
1. Install `uv` for package management
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```
1. Install all dependencies
```bash
uv sync
```
1. Save `sample.env` to `.env.dev` and edit accordingly for environment variables. Convenience script init-env.sh helps with this.
```bash
bash init-env.sh
```
1. To start the dev server:
```bash
bash dev.sh
```
## Production
1. Build the docker container
```bash
docker compose build
```
2. Run the container
```bash
docker compose up -d
```
## Stack
- List stack components here
## Contributors
- Bob YX Lee