36 lines
738 B
Markdown
36 lines
738 B
Markdown
# CargoTrace FastAPI Backend
|
|
|
|
FastAPI backend service for the CargoTrace platform.
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate # Linux/Mac
|
|
# or .venv\Scripts\activate # Windows
|
|
pip install -r requirements.txt
|
|
uvicorn app.main:app --reload
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Configuration is managed via YAML files in the `config/` directory.
|
|
|
|
### Configuration File
|
|
|
|
Edit `config/settings.yaml` to configure your environment:
|
|
|
|
```yaml
|
|
database:
|
|
sql_server:
|
|
host: your-host
|
|
port: 1433
|
|
database: your-database
|
|
username: your-username
|
|
password: your-password
|
|
```
|
|
|
|
### Local Overrides
|
|
|
|
For local development, create `config/settings.local.yaml` to override specific values without committing them.
|