- docs: add README

Author: koladev32

README.md

@@ -1 +1,141 @@
-# api-server-django
+
+# Django API Server
+
+Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is based on [json web tokens](https://jwt.io).
+
+<br />
+
+> Features:
+
+- Simple, intuitive codebase - built for beginners (can be extended with ease) 
+- Django / Django REST / Sqlite3 - a simple, easy to use backend
+- Authentication with JWT (JWT login, JWT logout)
+- Testing
+- Docker Support 
+- [API Interface Descriptor](https://github.com/app-generator/api-server-Django/blob/master/media/api.postman_collection.json): POSTMAN Collection
+- Docker 
+- Full-stack Samples that uses this backend 
+     - [React Node JS Berry](https://appseed.us/product/react-node-js-berry-dashboard) - open-source full-stack sample
+
+<br />
+
+> Support: 
+
+- Github (issues tracker), Email: **support @ appseed.us** 
+- **Discord**: [LIVE Support](https://discord.gg/fZC6hup) (registered AppSeed Users) 
+
+<br />
+
+![Django API Server - Open-source Django Starter provided by AppSeed.]()
+
+<br />
+
+## Requirements
+- Django==3.2.5
+- djangorestframework==3.12.4
+- PyJWT==2.1.0
+- django-cors-headers==3.7.0 
+
+<br />
+
+## How to use the code
+
+**Clone the sources**
+
+```bash
+$ git clone https://github.com/app-generator/api-server-django.git
+$ cd api-server-django
+```
+
+**Create a virtual environment**
+
+```bash
+$ virtualenv -p python3 venv
+$ source venv/bin/activate
+```
+
+**Install dependencies** using pip
+
+```bash
+$ pip install -r requirements.txt
+```
+
+**Start the API server** 
+
+```bash
+$ python manage.py migrate
+$ python manage.py runserver
+```
+
+The API server will start using the default port `8000`.
+
+
+<br />
+
+### [Docker](https://www.docker.com/) execution
+---
+
+> Get the code
+
+```bash
+$ git clone https://github.com/app-generator/api-server-django.git
+$ cd api-server-django
+```
+
+> Start the app in Docker
+
+```bash
+$ docker-compose up -d --build
+```
+
+Visit `http://localhost:5000` in your browser. The API server will be running.
+
+
+<br />
+
+## API
+
+For a fast set up, use this POSTMAN file: [api_sample](https://github.com/app-generator/api-server-Django/blob/master/media/api.postman_collection.json)
+
+> **Register** - `api/users/signup`
+
+```
+POST api/users/signup
+Content-Type: application/json
+
+{
+    "username":"test",
+    "password":"pass", 
+    "email":"[email protected]"
+}
+```
+
+<br />
+
+> **Login** - `api/users/login`
+
+```
+POST /api/users/login
+Content-Type: application/json
+
+{
+    "password":"pass", 
+    "email":"[email protected]"
+}
+```
+
+<br />
+
+> **Logout** - `api/users/logout`
+
+```
+POST api/users/logout
+Content-Type: application/json
+authorization: JWT_TOKEN (returned by Login request)
+
+{
+    "token":"JWT_TOKEN"
+}
+```
+
+<br />