DEVELOPERS.md

Developer Setup

Steps to setup

1. Clone the repository by running the following command in the terminal :

   $ git clone https://github.com/Beta-Persei/vaccination-slot-notifier.git

2. Create a virtual environment and activate it.

   $ python -m venv env
   $ source env/bin/activate (Linux)
   $ env\Scripts\activate (Windows)

3. Install dependencies by running the following command:

   $ pip install -r requirements.txt

4. Create a .env file using the .env.sample and add the required values

5. Run the Django standard runserver steps:

   $ python manage.py migrate
   $ python manage.py runserver

   Your website will be up and running at http://localhost:8000

Redis

Redis is used as a broker for celery.

1. Install

   $ sudo apt install redis-server

2. Test

   $ redis-cli ping
   PONG

Celery worker

Celery worker is used to send mails and other blocking tasks asynchronously.

celery -A vaccination_slot_notifier worker -l DEBUG

Celery beat

Used to run periodic tasks

celery -A vaccination_slot_notifier beat -l DEBUG