Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is built with json web tokens.
- 👉 Support via Discord & Email
- 🚀 Custom Development Services for
StartUPs
,Small Businesses
, andSolo-developers
- ✅
Up-to-date dependencies
- ✅ API Definition - the unified API structure implemented by this server
- ✅ Django / DRF / SQLite3 - a simple, easy to use backend
- ✅
JWT Authentication
(login, logout, register) - 🆕
OAuth
for Github- Full-stack ready with React Soft Dashboard
- ✅ Docker, Unitary tests
Can be used with other React Starters for a complete Full-Stack experience:
React Node JS Berry | React Node Soft Dashboard | React Node Horizon |
---|---|---|
👉 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
.
👉 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 - Create a new
.env
file using sampleenv.sample
The meaning of each variable can be found below:
DEBUG
: ifTrue
the app runs in develoment mode- For production value
False
should be used
- For production value
SECRET_KEY
: used in assets managementGITHUB_CLIENT_ID
: For GitHub social loginGITHUB_SECRET_KEY
: For GitHub social login
👉 Step #5 - Start the API server
$ python manage.py migrate
$ python manage.py runserver
The API server will start using the default port 8000
.
$ python manage.py test
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