Keep learning

Develop

Python version

3.9

Create virtual environment

python -m venv .venv

Activate virtual environment

.venv\Scripts\activate

Install dependencies

python -m pip install --upgrade pip
pip install -r requirements.txt

Migrate database

python manage.py migrate

Run development server

python manage.py runserver

Debug

For Visual studio code

Just press F5 (Config is inside keep-learning.code-workspace)

For other editors

Please contribute if you know how.

Config environment variables

Default variables should work out of the box already, but in case you want to customize, here is how.

Add .env file and write your custom variables to it.

Available variables and their data type can be seen in keep_learning/settings.py:

env = environ.Env(
    ...  # Variables are listed here
)

Browsable API

You can login to the browsable API and explore it to help with development.

Collect static

python manage.py collectstatic

Browse!

Go to this URL in your brower. (You may need to register new user and then login if you haven't already)

http://localhost:8000/

Setup background tasks

NOTE This is only needed if you develop features involving background tasks, like sending email, .etc

Rabbitmq

Setup with docker

docker run -d --name rabbitmq -p 5672:5672 rabbitmq

Create user and vhost

Exec into container

docker exec -it rabbitmq bash

Create user, vhost

rabbitmqctl add_user kl_user kl_password
rabbitmqctl add_vhost kl_vhost
rabbitmqctl set_permissions -p kl_vhost kl_user ".*" ".*" ".*"

Celery

Start the worker process

celery --app keep_learning worker --loglevel INFO --pool solo

NOTE Every time you make changes to a task, celery worker should be restarted.

Sending emails

In development, emails are not actually sent, but instead saved to temp/sent_emails. You can inspect this directory to test email sending features.