dj_tahweela

Behold My Awesome Project!

License:	MIT

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
To create an superuser account, use this command:
```
$ python manage.py createsuperuser
```

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy dj_tahweela

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with py.test

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Celery

This app comes with Celery.

To run a celery worker:

cd dj_tahweela
celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation.

Run & go

PLEASE NOTE: I kept the .env/* and credentials as plain for easier reviewing. Build and Run the app using docker. ```bash $ docker-compose -f local.yml build $ docker-compose -f local.yml up

$ docker-compose -f local.yml run django python manage.py makemigrations $ docker-compose -f local.yml run django python manage.py migrate $ docker-compose -f local.yml run django python manage.py createsuperuser $ firefox http://localhost:8000/ ``` Django shell: docker-compose -f local.yml run --rm django python manage.py shell_plus ` Logs: `docker-compose -f local.yml logs Unittests: $ docker-compose -f local.yml run django python manage.py test

API

Please, Check Postman collection. But for quick examples: 1. POST http://localhost:8000/auth-token/

body {"username": "elmarzouki", "password": "elmarzouki"} response {"token": "32b48b9816a0ea7d12c32af9b6153210cc8c17c7"}

GET http://localhost:8000/api/users/me/ headers Authorization = TOKEN 32b48b9816a0ea7d12c32af9b6153210cc8c17c7 response logged user data
GET http://localhost:8000/api/currencies/status/ response {"Status": "Currencies App Up!"}
POST http://localhost:8000/api/currencies/exchange_rate/ body: {"from_currency": "USD","to_currency": "EGP","user_id": 1} response history recored including exchange_rate and refreshed_at
POST http://localhost:8000/api/currencies/exchange_rate_time_series/ body {"from_currency": "USD", "to_currency": "EGP", "req_type" :"FX_INTRADAY"} response exchange rate time series

elmarzouki/dj_tahweela