Updated README

This commit is contained in:
Thastertyn 2024-03-12 20:11:26 +01:00
parent 3c35ac4075
commit 248bf45044

View File

@ -1,6 +1,19 @@
# SHOP API
Simple API (still WIP)
## Requires:
1. Redis
Simple redis installation, no further configuration needed
2. MariaDB (or MySQL)
Make sure a proper database is set up with `shop.sql`
## Running:
Gunicorn is the simplest way to run this project
```sh
gunicorn -w 4 -b HOST:PORT main:app
```
# Routes
## Hello World