README.md

PhotoGram

A photo collection/sharing hub.

• Built using Python and Django (DRF) with test driven development (TDD) approach
• Contains APIs for:
  • USERS : Register new user, login, logout etc.
  • ROLES : View role, registered user role, admin/staff role etc.
  • SHARING : Share photos using shareable link via token auths & link expiration feature
  • CRUDing : Create, retrieve, update, and destroy photos

Prerequisites

• Python >= 3.7, pip
• MySQL Server, Client (optional)

Installation

• Install dependencies

pip install pipenv
cd photogram
pipenv install

• Migrate

If using MySQL then create databse (optional)

create database photogram CHARACTER SET utf8;

pipenv shell
cd src
python manage.py migrate

Run

• Start application server

python manage.py runserver

will run the server at 127.0.0.1:8000 by default.

API Documentation

• open following link to explore the API docs
  http://127.0.0.1:8000

Code Coverage

coverage run --source='.' manage.py test
coverage report -m