Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/api-server-django
Django API Server - Open-Source API Server | AppSeed
https://github.com/app-generator/api-server-django
appseed-sample django-api django-api-framework django-api-oauth django-api-sample django-api-server django-oauth django-rest-framework python-api python-django-api
Last synced: 2 months ago
JSON representation
Django API Server - Open-Source API Server | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/api-server-django
- Owner: app-generator
- License: other
- Created: 2021-07-03T07:15:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T08:25:56.000Z (6 months ago)
- Last Synced: 2024-10-11T04:43:40.274Z (3 months ago)
- Topics: appseed-sample, django-api, django-api-framework, django-api-oauth, django-api-sample, django-api-server, django-oauth, django-rest-framework, python-api, python-django-api
- Language: Python
- Homepage: https://appseed.us/boilerplate-code/django-boilerplate/
- Size: 102 KB
- Stars: 41
- Watchers: 3
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django API Server](https://appseed.us/boilerplate-code/django-boilerplate/)
Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is built with [json web tokens](https://jwt.io).
- 👉 [Support](https://appseed.us/support/) via **Discord & Email**
- 🚀 [Custom Development Services](https://appseed.us/custom-development/) for `StartUPs`, `Small Businesses`, and `Solo-developers`
## Features:
- ✅ `Up-to-date dependencies`
- ✅ [API Definition](https://docs.appseed.us/boilerplate-code/api-unified-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](https://github.com/app-generator/react-soft-ui-dashboard)
- ✅ Docker, Unitary tests
> Can be used with other [React Starters](https://appseed.us/apps/react) for a complete **Full-Stack** experience:
| [React Node JS Berry](https://appseed.us/product/berry-dashboard/api-server-nodejs/react/) | [React Node Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/api-server-nodejs/react/) | [React Node Horizon](https://appseed.us/product/horizon-ui/api-server-nodejs/) |
| --- | --- | --- |
| [](https://appseed.us/product/berry-dashboard/api-server-nodejs/react/) | [](https://appseed.us/product/soft-ui-dashboard/api-server-nodejs/react/) | [](https://appseed.us/product/horizon-ui/api-server-nodejs/)
## ✨ Quick Start in `Docker`
> 👉 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 --build
```
The API server will start using the PORT `5000`.
## ✨ How to use the code
> 👉 **Step #1** - Clone the sources
```bash
$ git clone https://github.com/app-generator/api-server-django.git
$ cd api-server-django
```
> 👉 **Step #2** - Create a virtual environment
```bash
$ # 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
```bash
$ pip install -r requirements.txt
```
> 👉 **Step #4** - Create a new `.env` file using sample `env.sample`
The meaning of each variable can be found below:
- `DEBUG`: if `True` the app runs in develoment mode
- For production value `False` should be used
- `SECRET_KEY`: used in assets management
- `GITHUB_CLIENT_ID`: For GitHub social login
- `GITHUB_SECRET_KEY`: For GitHub social login
> 👉 **Step #5** - Start the API server
```bash
$ python manage.py migrate
$ python manage.py runserver
```
The API server will start using the default port `8000`.
## ✨ Tests
```bash
$ python manage.py test
```
## ✨ 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]"
}
```
> **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](https://github.com/app-generator/api-server-django)** - provided by [AppSeed](https://appseed.us)