diff --git a/README.md b/README.md index 0130460..210e59f 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,9 @@ python manage.py import_data *Note!* Instructions are made for a modern linux environment. +- **Step 0:** Make sure that you have installed the dependencies. +You need `git, python, python-virtualenv, redis` + - **Step 1:** Clone repo ```bash @@ -138,11 +141,47 @@ pip install -r requirements.txt - **Step 6:** Copy environment config file and change it to your liking ```bash -cp env-sample .env +cp env-sample archivist/.env ``` -- **Step 7:** Run django server +- **Step 7:** Change directory to archivist ```bash -python3 archivist/manage.py runserver +cd archivist +``` + +- **Step 8:** Run django database migrations + +```bash +python manage.py migrate +``` + +- **Step 9:** Start the redis server + +```bash +redis-server +``` + +- **Step :10** Open another shell and start the django server + +```bash +python3 manage.py runserver +``` + +- **Step :11** Open another shell inside of `archivist/` folder and start the django server + +```bash +python3 manage.py runserver +``` + +- **Step :11** Open another shell inside of `archivist/` folder and start the celery worker + +```bash +celery -A core worker -l info +``` + +- **Step :11** Open another shell inside of `archivist/` folder and start the celery beat + +```bash +celery -A core beat -l info ```