89 lines
1.5 KiB
Markdown
89 lines
1.5 KiB
Markdown
# {{cookiecutter.project_name}}
|
|
|
|
{{cookiecutter.project_short_description}}
|
|
|
|
## Development
|
|
|
|
The only dependencies for this project should be docker and docker-compose.
|
|
|
|
### Quick Start
|
|
|
|
1. 创建配置文件
|
|
|
|
```bash
|
|
cp config.toml.template config.toml
|
|
```
|
|
|
|
2. 启动项目
|
|
|
|
Starting the project with hot-reloading enabled
|
|
(the first time it will take a while):
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
To run the alembic migrations (for the users table):
|
|
|
|
```bash
|
|
docker-compose run --rm backend alembic upgrade head
|
|
```
|
|
|
|
### Rebuilding containers:
|
|
|
|
```
|
|
docker-compose build
|
|
```
|
|
|
|
### Restarting containers:
|
|
|
|
```
|
|
docker-compose restart
|
|
```
|
|
|
|
### Bringing containers down:
|
|
|
|
```
|
|
docker-compose down
|
|
```
|
|
|
|
## Logging
|
|
|
|
```
|
|
docker-compose logs
|
|
```
|
|
|
|
Or for a specific service:
|
|
|
|
```
|
|
docker-compose logs -f name_of_service # frontend|backend|db
|
|
```
|
|
|
|
## Project Layout
|
|
|
|
```
|
|
backend
|
|
└── app
|
|
├── alembic
|
|
│ └── versions # where migrations are located
|
|
├── api
|
|
│ └── api_v1
|
|
│ └── endpoints
|
|
├── core # config
|
|
├── db # db models
|
|
├── tests # pytest
|
|
└── main.py # entrypoint to backend
|
|
|
|
frontend
|
|
└── public
|
|
└── src
|
|
├── components
|
|
│ └── Home.tsx
|
|
├── config
|
|
│ └── index.tsx # constants
|
|
├── __tests__
|
|
│ └── test_home.tsx
|
|
├── index.tsx # entrypoint
|
|
└── App.tsx # handles routing
|
|
```
|