minor
This commit is contained in:
33
server/README.md
Normal file
33
server/README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
## Building materials catalog API
|
||||
|
||||
REST API: `/api/v1`
|
||||
|
||||
### Run
|
||||
|
||||
```bash
|
||||
dart pub get
|
||||
dart run bin/server.dart
|
||||
```
|
||||
|
||||
### Required env vars
|
||||
|
||||
- `PGHOST` (default `127.0.0.1`)
|
||||
- `PGPORT` (default `5432`)
|
||||
- `PGDATABASE` (default `building_catalog`)
|
||||
- `PGUSER` (default `postgres`)
|
||||
- `PGPASSWORD` (default `postgres`)
|
||||
- `JWT_SECRET` (default `dev-secret`)
|
||||
- `ADMIN_EMAIL` (default `admin@shop.local`)
|
||||
- `ADMIN_PASSWORD` (default `secret`)
|
||||
- `PORT` (default `8080`)
|
||||
|
||||
### Main routes
|
||||
|
||||
- `GET /api/v1/categories`
|
||||
- `GET /api/v1/brands`
|
||||
- `GET /api/v1/products`
|
||||
- `GET /api/v1/products/{id}`
|
||||
- `POST /api/v1/auth/login`
|
||||
- `POST|PATCH|DELETE /api/v1/admin/categories...`
|
||||
- `POST|PATCH|DELETE /api/v1/admin/brands...`
|
||||
- `POST|PATCH|DELETE /api/v1/admin/products...`
|
||||
Reference in New Issue
Block a user