Configuration
Environment Variables
See .env.example in the repository for the full list of values.
App
| Variable | Description |
|---|---|
APP_NAME | Application name |
APP_DESCRIPTION | Application description |
APP_VERSION | API version |
APP_ENV | Environment name |
APP_PORT | HTTP port |
Database Mode
Set DB_CLIENT to one of the supported values:
| Value | Database |
|---|---|
postgres | PostgreSQL |
mysql | MySQL |
sqlite | SQLite |
nosql | NoSQL (Mongo) |
SQL Settings
| Variable | Description |
|---|---|
DB_URL | Full connection URL |
DB_HOST | Host |
DB_PORT | Port |
DB_USER | Username |
DB_PASSWORD | Password |
DB_NAME | Database name |
DB_SSL | Enable SSL |
DB_SQLITE_FILE | SQLite file path |
NoSQL Settings
| Variable | Description |
|---|---|
NOSQL_PROVIDER | Provider (e.g. mongodb) |
NOSQL_URI | Connection URI |
NOSQL_DATABASE | Database name |
Database Configuration Examples
PostgreSQL:
DB_CLIENT=postgres
DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=app_dbMySQL:
DB_CLIENT=mysql
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=secret
DB_NAME=app_dbSQLite:
DB_CLIENT=sqlite
DB_SQLITE_FILE=./data/app.dbNoSQL (MongoDB):
DB_CLIENT=nosql
NOSQL_PROVIDER=mongodb
NOSQL_URI=mongodb://localhost:27017
NOSQL_DATABASE=app_nosql_dbDeployment Notes (Vercel)
- Keep Swagger assets stable in production with CDN URLs.
- Use relative OpenAPI URL for docs route compatibility.
- Ensure the latest commit is deployed before testing
/docs.