Create a community of like minded authors to foster inspiration and innovation by leveraging the modern web.

• Python 3.6
• Postgres database
• Pip or any other python package manager

• Django
• Pycodestyle

Clone the project repo to your prefered location

$ git clone https://github.com/andela/ah-backend-stark.git

Install a virtual environment via pip or prefered package manager

$ pip install virtualenv

Create a virtual environment. "env" can be any name

$ virtualenv env

Activate environment

• On Windows $ env\scripts\activate

• On Mac OS $ source env/bin/activate

Install dependencies

$ pip install -r requirements.txt

Rename the .env.example file to .env and change the dummy fields to your respective database connection credencials

Make migrations

$ python manage.py makemigrations

$ python manage.py migrate

$ python manage.py tests

Tests with coverage

$ coverage run --source=authors/ manage.py test

$ coverage report -m

Run server

$ python manage.py runserver

Endpoints that can be tested on Postman

Documentation on how to test the endpoints

Heroku