Files
us-api/README.md
Chip Wasson d00fe6fdb7
All checks were successful
Gitea Actions Demo / build (push) Successful in 5m20s
Add redirects
2023-12-04 16:46:16 -07:00

35 lines
669 B
Markdown

# us.dev Generalized API
AKA _the monolith_
## Quickstart
Dependencies:
- Docker
- Node 18
```sh
# Copy example .env
cp .env.example .env
# Install Dependencies
yarn
# Start local services
docker compose up -d
# Copy default data into local minio
cp -r default/* data/minio/devbucket
# Start Application
yarn start:dev
```
Visit http://localhost:3000/api
## Configuration
Supply the following environment variables:
| Env Name | Description |
| ---------- | ------------------------------------------- |
| JWT_SECRET | A big string to use as the JWT token secret |
| ADMIN_PASS | The password for the `admin` user |