From 13abb5f535f5bec26a258bb1f3f780dd16a875a7 Mon Sep 17 00:00:00 2001 From: Mbaoma Date: Fri, 6 Jan 2023 03:43:05 +0100 Subject: [PATCH] include steps to run locally. started setting up nginx --- .gitignore | 3 +-- README.md | 18 +++++++++++++++++- server-set-up.md | 13 +++++++++++++ 3 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 server-set-up.md diff --git a/.gitignore b/.gitignore index f1d4cd5..2ee1542 100644 --- a/.gitignore +++ b/.gitignore @@ -12,5 +12,4 @@ postgres_data/ *.json *.pem data/ -*.pem - +*.pem \ No newline at end of file diff --git a/README.md b/README.md index 5db58a0..c001366 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) \ No newline at end of file +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) + +## Running the project locally +- Activate a virtual environment +```bash +source venv/bin/activate +``` + +- Install requirements +```bash +pip install -r requirements.txt +``` + +- Run the project +```bash +flask run +``` \ No newline at end of file diff --git a/server-set-up.md b/server-set-up.md new file mode 100644 index 0000000..31e37f4 --- /dev/null +++ b/server-set-up.md @@ -0,0 +1,13 @@ +- Install [nginx](https://nginx.org/en/linux_packages.html#Ubuntu) + +- The application runs on a docker image, so we run +```bash +sudo docker run -d +``` + +- Install ```Gunicorn``` + +- Edit the ```/etc/nginx/sites-available/default``` file, to: +```bash + +``` \ No newline at end of file