favorite-things

Britecore-app

About

Favorite-things is an API that enables you to keep track of all you favorite things. It is hosted at 'https://favorite-things-back.herokuapp.com'

Technologies

• Python 3
• Django Rest Framework
• PostgreSQL
• Docker
• docker-compose

The front-end service is built using the Vue. Hosted on heroku https://favorite-things-front.herokuapp.com/v1/

Project setup

Ensure to install the above technologies listed before you start.

Clone repository

$ git clone https://github.com/matthewacha/favorite-things.git
$ cd favorite-things

Setup virtualenv

$ virtualenv -p python3 venv
$ source venv/bin/activate

Setup environment variables

For Mac

export PORT=<database port> DB_HOST=<database host> DB_PASSWORD=<database passord> DB_USER=<database user> DB_NAME=<databse name>

Install dependencies

pip3 install -r requirements.txt

Apply migrations

$ python3 manage.py migrate

Run the server

$ python3 manage.py runserver

To run tests

$ python3 manage.py test

with coverage

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

run with docker

$ docker-compose build

$docker-compose up

Documentation on usage of the API

Documentation for the usage of the API endpoints can be found at http://127.0.0.1:8000/docs/ when running a local server.