Skip to content

Latest commit

 

History

History
60 lines (56 loc) · 1.3 KB

README.md

File metadata and controls

60 lines (56 loc) · 1.3 KB

Django Rest API Boilerplate

Technology used

  1. Python3.8
  2. Django 3
  3. Django Rest Framework
  4. MySql
  5. Docker

Features

  • User SignIn/SignUp
  • Forget Password
  • Email Verification
  • Login with Social Accounts (Facebook/Google)
  • OAuth 2.0 (Authentication with Access & Refresh Token)
  • Swagger Documentation
  • Testing - [Coming Soon]
  • Docker Config - [Coming Soon]

Setup in your local machine

  1. Clone project
git clone https://github.com/morshedmasud/django-rest-framework-mysql-boilerplate
  1. Go to project root path and create virtualenv
virtualenv -p python3 venv
  1. Active virtualenv
source venv/bin/activate
  1. Install all dependency
pip3 install -r requirements.txt
  1. Don't forget to create .env file as like .env.example and put necessary values like DB Info, Email Info
  2. Database migrations
python3 manage.py makemigrations
  1. Database Migrate
python3 manage.py migrate
  1. Database Migrate and Seeder
bash migrate_and_seed.sh
  1. Finally, run the project by
python3 manage.py runserver
  1. Generated staticfiles
python3 manage.py collectstatic

Open the following url for view swagger documentation

(http://localhost:8000/swagger/)