Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oleoneto/lua-server
Backend server for the Lua LMS.
https://github.com/oleoneto/lua-server
django django-admin django-rest-framework docker dokku heroku json-api python-3-6
Last synced: 17 days ago
JSON representation
Backend server for the Lua LMS.
- Host: GitHub
- URL: https://github.com/oleoneto/lua-server
- Owner: oleoneto
- License: gpl-3.0
- Created: 2019-01-23T05:56:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-03T07:32:45.000Z (almost 5 years ago)
- Last Synced: 2024-11-17T07:07:42.215Z (2 months ago)
- Topics: django, django-admin, django-rest-framework, docker, dokku, heroku, json-api, python-3-6
- Language: Python
- Homepage:
- Size: 278 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lua-server
Backend server for Lua LMS
### Requirements
As listed in [requirements.txt](requirements.txt)
### Secrets
In order to run the project, create a `secrets.py` file next to `settings.py`.
This file should contain the following configuration:
```python
ADMINS = (
('Name', '[email protected]'),
)
```
You will also need to define the environment variables found in [.env](lua/.env-example). You should set those variables inside `.env`.
### API
In order to access the API, please provide your authentication `token`.
Include it in the request header:
```text
http GET 'http://localhost:8000/api/v1/users' \
'Authorization':'Token 8g*****************1'
```
The API also supports JWT authentication. The endpoint is at:
```text
```
The documentation of the API is at the following path:
```text
http://localhost:8000/api/v1/documentation
```
The project uses Swagger to display the endpoints and provide
a way of interacting with the resources.
### Two-Factor Authentication
2FA is required for admin site, but optional for te rest of the site.
Check 2FA status for a given user:
```
manage.py two_factor_status username
```
Disable 2FA for a given user:
```
manage.py two_factor_disable username
```
### Build and run application
```text
manage.py makemigrations core && \
manage.py migrate core && \
manage.py migrate && \
manage.py runserver
```
Built by **Leo Neto** with [Django CLI](https://github.com/oleoneto/django-clite)