diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..ac4a7fe --- /dev/null +++ b/readme.md @@ -0,0 +1,41 @@ + + +# eve\_structure + +A small Flask server for managing orders. + +## Requirements + +* Python +* Docker + +## Setup + +Install the Python dependencies: +```bash +pip install -r requirements.txt +``` + +## Running for Development + +```bash +python main.py +``` + +## Running with Docker + +Build the Docker image: + +```bash +docker build -t eve_structure . +``` + +Or simply use Docker Compose: + +```bash +docker-compose up +``` + +## Notes + +* `instance` directory is used to store the database (`orders.json`).