lucasoskorep/mta-sign
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: finish readme and add swagger

Browse Source
This commit is contained in:
Lucas Oskorep
2026-01-20 22:50:05 -05:00
parent dc8a2c9d3e
commit 33c7a108e2
3 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -9,7 +9,8 @@ Initially designed to run directly on a raspberry pi, it has been containerized
podman or docker!
Additionally, this can be run without the frontend in case you just wanted a slightly more sane way to query MTA's data
sources compared to their stock APIs.
sources compared to their stock APIs. Swagger is hosted at /swagger
![swagger.png](attachments/swagger.png)
## Features
@@ -46,9 +47,10 @@ The application will be available at `http://localhost:8000`
### Environment Variables
| Variable | Description | Default | Required |
|-------------------|---------------------------------|---------|----------|
| `FRONTEND_ENABLE` | Enable/disable the web frontend | `true` | No |
| Variable | Description | Default | Required |
|-------------------|------------------------------------------------------------|---------|----------|
| `FRONTEND_ENABLE` | Enable/disable the web frontend | `true` | No |
| `SHOW_SWAGGER` | Enable/disable Swagger API documentation at `/swagger` | `false` | No |
### Running with Docker Compose