|
1 | 1 |
|
2 | 2 | # Django API Server |
3 | 3 |
|
4 | | -Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is based on [json web tokens](https://jwt.io). |
| 4 | +Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is built with [json web tokens](https://jwt.io). |
5 | 5 |
|
6 | 6 | <br /> |
7 | 7 |
|
8 | 8 | > Features: |
9 | 9 |
|
10 | 10 | - [API Definition](https://docs.appseed.us/boilerplate-code/api-unified-definition) - the unified API structure implemented by this server |
11 | | -- Simple, intuitive codebase - built for beginners (can be extended with ease) |
12 | | -- Django / Django REST / Sqlite3 - a simple, easy to use backend |
13 | | -- Authentication with JWT (JWT login, JWT logout) |
14 | | -- Testing, Docker |
15 | | -- [API Interface Descriptor](https://github.com/app-generator/api-server-nodejs/blob/master/media/api.postman_collection.json): POSTMAN Collection |
| 11 | +- Simple, intuitive codebase - can be extended with ease |
| 12 | +- Django / Django REST / SQLite3 - a simple, easy to use backend |
| 13 | +- Authentication with JWT (login, logout, register) |
| 14 | +- PRO version available - **[Django API Server PRO](https://github.com/app-generator/api-server-django-pro)** |
| 15 | + - Support for Mongo DB, Docker, Unitary tests, and priority support |
16 | 16 |
|
17 | 17 | <br /> |
18 | 18 |
|
@@ -91,14 +91,19 @@ $ cd api-server-django |
91 | 91 | > Start the app in Docker |
92 | 92 |
|
93 | 93 | ```bash |
94 | | -$ docker-compose up -d --build |
| 94 | +$ docker-compose up --build -d |
95 | 95 | ``` |
96 | 96 |
|
97 | 97 | Visit `http://localhost:5000` in your browser. The API server will be running. |
98 | 98 |
|
99 | | - |
100 | 99 | <br /> |
101 | 100 |
|
| 101 | +## Tests |
| 102 | + |
| 103 | +```bash |
| 104 | +$ python manage.py test |
| 105 | +``` |
| 106 | + |
102 | 107 | ## API |
103 | 108 |
|
104 | 109 | 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) |
|
0 commit comments