markaphillips / auth-api

REST API to handle user registration and authentication

Pre-requisites

Docker

Python (== 3.8.3)

Ensure env vars are set as follows:

cat > build/.env << EOF
DEBUG=True
SECRET_KEY=**********
ADMIN_USER_PWD=***********
ADMIN_USER_EMAIL=******@********
POSTGRES_DB=auth
POSTGRES_PASSWORD=**********
POSTGRES_USER=postgres
EOF

Run Locally

In the project root run:

docker-compose down -v --rmi all
docker-compose up --build 

Navigate to http://localhost:8000/admin

Login using the credentials defined in the .env file.

Notes

Running the following will generate a requirements.txt file in the build folder:

pipenv shell
pipenv lock -r > ./build/requirements.txt

In the production environment the DATABASE_URL is used to connect to a postgres database hosted on Heroku.

Locally docker-compose spins up a postgres instance using the POSTGRES_* env variables.

auth-api's Issues

Auth - Ensure superuser account is set up correct and linked as part of CI build

Ensure lastname and firstname are filled in
Ensure User created is linked to an Account

Currently this has to be done manually via the admin when the account is setup

Add Circle CI build to deploy to Heroku using Docker

Auth - Ensure Errors are returned as JSON rather than returning a HTML view

Currently some errors (500 internal) return a HTML view - should return a JSON error response

Auth - Add API to Register an User

Dockerise local application and refactor build based on changes

Need to implement changes to local deployment to be able to containerise the application

Auth - Add Django Tests for API and add to CD pipeline

For both login and registration

Add API to authenticate a username/password and return a JWT token

Auth - Add versioning strategy and implement for releases to master branch

see https://www.django-rest-framework.org/api-guide/versioning/#configuring-the-versioning-scheme

Version will need to be tagged in Git as a release

Auth - Review Database (db.sqlite3) / migrations - update to postgres - locally and in prod

Possibly change Database to Postgres - see pricing options