Git Product home page Git Product logo

django-quickstarter's Introduction

Django-Quickstarter

Updates Python 3

What's included

  • Custom user
  • Authentication(JWT) with Registration
  • Requirements file
  • Django REST framework
  • API Documentations(Swagger & Redoc)
  • Django CORS headers

Installation

Prepare a virtual environment in a folder of choice and install Django:

mkdir newproject && cd $_
python3 -m venv venv
source venv/bin/activate
pip install django

Then install the template:

django-admin startproject --template https://github.com/sirrobot01/django-quickstarter/archive/master.zip newproject .

Install the dependencies:

pip install -r requirements.txt

Before starting off make the migrations for the custom User and Authentications:

python manage.py makemigrations
python manage.py migrate

and you are good to go!!

SSL Issues on MacOS

You might encounter an issue starting the project. You have two options

Option 1

  • Clone this repo: git clone https://github.com/sirrobot01/django-quickstarter.git
mkdir newproject && cd $_
python3 -m venv venv
source venv/bin/activate
pip install django

Then install the template:

django-admin startproject --template django-quickstarter newproject .

Install the dependencies:

pip install -r requirements.txt
python manage.py makemigrations
python manage.py migrate

Option 2

  • Click on "Use this template"
  • Create a new repo off this on your account
  • Pull/Clone to your local computer
  • Create a virtualenv
  • pip install -r requirements.txt
python manage.py makemigrations
python manage.py migrate

Endpoints

Authentications
  • Register POST /auth/register/
  • Login POST /auth/login/
  • Refresh JWT Token POST /auth/refresh/
  • Verify JWT Token POST /auth/verify/
Note: Check /swagger/ or /redoc/ for other endpoints
Documentations
  • Swagger GET /swagger
  • Redoc GET /redoc/

Running Tests

python manage.py test

django-quickstarter's People

Contributors

pyup-bot avatar sirrobot01 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.