Setup and Run Application Locally

1. Install Python 3.10.4.
2. Install Redis and start it using redis-server use default port of 6379
3. Clone repo to somewhere sensible on machine
   1. git clone https://github.com/coliin8/book_explorer.git
4. cd book_explorer
5. Setup Virtual Env
   1. python -m venv .
6. Activate venv 1. Windows: Scripts\activate.bat 2. Linux/Mac: source bin/activate
7. Run pip install -f requirements.txt
8. Setup Environmental Variables
   1. AWS_ACCESS_KEY_ID=Your_Key_id
   2. AWS_SECRET_ACCESS_KEY=Your_Secret_Token
9. Run python manage.py migrate to run migration and generate database
10. Run python manage.py runserver
11. Run celery --app book_explorer worker -l info

Run in Docker

0. Assume you have checked out repo from git
1. cd book_explorer
2. Open docker-compose.yml file
   1. Update Environment Variables with your details:
      1. AWS_ACCESS_KEY_ID
      2. AWS_SECRET_ACCESS_KEY
3. docker-compose up -d
   1. Web App on http://localhost:8000/books
   2. Flower on http://localhost:5555
   3. Redis exposed on redis://localhost:6379

Run Tests

pytest

Creating an admin user

First we’ll need to create a user who can login to the admin site. Run the following command:

python manage.py createsuperuser

Enter your desired username and press enter.

Username: admin

You will then be prompted for your desired email address:

Email address: [email protected]

The final step is to enter your password. You will be asked to enter your password twice, the second time as a confirmation of the first.

Password: **********
Password (again): *********
Superuser created successfully.

Development Server and admin

python manage.py runserver

Goto http://127.0.0.1/admin

You can login with admin user credentials