diff --git a/DV8-Expo/README.md b/DV8-Expo/README.md index b5d3ac2..bd75c60 100644 --- a/DV8-Expo/README.md +++ b/DV8-Expo/README.md @@ -1,2 +1,24 @@ -# Game Expo website -:3 \ No newline at end of file +# Game Expo 2023 +The all new and upgraded website that runs on the Flask macro-framework + + +## Developing +### Prerequisites +Clone the latest branch, and create a venv environment. Then, install the requirements.txt file. + +To create the required database run: +```bash +$ flask --app website init-db +``` + +### Running +To run the website, run the following command: +```bash +$ flask --app website run +``` + +## Running +While the docker-compose file runs the program for you, its possible to just run the file locally. +```bash +# gunicorn --bind="0.0.0.0:5000" --workers=4 website:app +```