charithmadhuranga / api-server-django

Django API Server - Open-Source API Server | AppSeed

Django API Server

Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is built with json web tokens.

Features:

• Up-to-date dependencies
• API Definition - the unified API structure implemented by this server
• Simple, intuitive codebase - can be extended with ease
• Django / DRF / SQLite3 - a simple, easy to use backend
• Authentication with JWT (login, logout, register)
• Docker, Unitary tests

✨ Quick Start in Docker

Get the code

$ git clone https://github.com/app-generator/api-server-django.git
$ cd api-server-django

Start the app in Docker

$ docker-compose up --build  

The API server will start using the PORT 5000.

PRO Version available: MongoDB persistance, Docker, Unitary Tests, 24/7 LIVE Support via Discord

Can be used with other React Starters for a complete Full-Stack experience:

React Node JS Berry	Full-Stack Material PRO	React Node Datta Able

✨ How to use the code

Step #1 - Clone the sources

$ git clone https://github.com/app-generator/api-server-django.git
$ cd api-server-django

Step #2 - Create a virtual environment

$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate

Step #3 - Install dependencies using PIP

$ pip install -r requirements.txt

Step #4 - Start the API server

$ python manage.py migrate
$ python manage.py runserver

The API server will start using the default port 8000.

✨ Tests

$ python manage.py test

✨ API

For a fast set up, use this POSTMAN file: api_sample

Register - api/users/signup

POST api/users/signup
Content-Type: application/json

{
    "username":"test",
    "password":"pass", 
    "email":"[email protected]"
}

Login - api/users/login

POST /api/users/login
Content-Type: application/json

{
    "password":"pass", 
    "email":"[email protected]"
}

Logout - api/users/logout

POST api/users/logout
Content-Type: application/json
authorization: JWT_TOKEN (returned by Login request)

{
    "token":"JWT_TOKEN"
}

---

Django API Server - provided by AppSeed App Generator