Wise API Boilerplate

This is an opinionated Django boilerplate to start Rest API projects

Stack

• Django as main web Framework
• Django Rest Framework as API development tooling
• Postgres for SQL Database
• Django Q for scheduled and async tasks.
• Docker/docke-compose for development and standalone deployments.

Features

• Registration
• Autthentication (JWT Token, OTP)
• Accounts (Users/Devices)
• Social Networks Support (Facebook/Google).
• API Documentation
• Deployment Tools

Getting started

You need to have installed git, docker, ssh and a decent terminal.

1. make build build the images for development.
2. make fixtures load initial data (optional).
3. make up start development server.

Probably you need to user the following command for another situations.

• make django to enable debug mode during development.
• make migrations run django makemigrations command
• make migrate run django migrate command
• make superuser make a superuserfor develoment

Testing

• make test run pytest over all test files in the project
• make test ARG=path_to_file run pytest of a single test file.

Code Quality

Firstly we need to configure pre-commit hooks, we need to do this just one time.

• brew install pre-commit installs pre-commit
• pre-commit install install hooks in the current repo.
• pre-commit autoupdate enables the pre-commit autoupdate.

Recurring commands:

• make coverage run pytest and generate the coverage report.
• make lint run flake8 and generate linting report.
• make report_coverage serves the coverage report as html at localhost:3000
• make report_lint serves the lint report as html at localhost:3001

Pre commit actions

• make isort Fix posible import issues
• make lint Check code quality based on PEP-8 styleguidees
• make test Run the tests with pytest

Transactional Frontend

This project has a transactional minimum frontend views, it is to process flows like:

• Confirm Email
• Reset password

The usage of these views are completely optional. If you want to testi it by yourself you need to have nodejs installed, after that run the following commands:

• npm install --global gulp-cli Install gulp globally
• npm install Install nodejs dependencies
• gulp generate css, js frontend assets.

To-Dos

• Postman Initial Collection
• Swagger API docs
• Deployment Guides [wise-cli, wise-cdk]
• Use black as style guide