README.md

Epigram - back

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Running the app
• Deployment
• Documentation
• Migrations
• License
• Contact

About The Project

Epigram is an Instagram-like allows yout to post, like and share photos!

Api of the app project.

Built With

• Django Rest Framework

Getting Started

Prerequisites

• Python ^3.6.9

Installation

Create virtual environment

py -m venv env

Activate virtual environment

.\env\Scripts\Activate.ps1 # PowerShell
source env/Scripts/activate # Linux

Install required python packages

pip install -r requirements.txt

Running the app

Run server

py manage.py runserver

Deployment

This project is link with an Heroku application, pushing to master will trigger an auto-deployment :

• https://epigrambe.herokuapp.com/

Documentation

The code is documented using a Swagger that you can browse at the /swagger endpoint

Migrations

Create migrations

py manage.py makemigrations

Apply migrations

py manage.py migrate

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/EpiReactNative/back
Swagger url http://localhost:8000/api/swagger