https://github.com/diaga/twix-server
AppCon Task Manager Backend
https://github.com/diaga/twix-server
Last synced: about 1 year ago
JSON representation
AppCon Task Manager Backend
- Host: GitHub
- URL: https://github.com/diaga/twix-server
- Owner: Diaga
- License: mit
- Created: 2019-10-10T13:58:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-01T06:20:34.000Z (over 6 years ago)
- Last Synced: 2025-02-05T13:34:39.285Z (over 1 year ago)
- Language: Python
- Size: 688 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twix Backend
[](https://travis-ci.com/Diaga/django-api-template)
This project is templated from [Django API Template](https://github.com/Diaga/django-api-template)(A template for creating robust APIs with django rest framework!)
The project codenamed as "Twix Server" while the real application label being **Cask**, is the backend REST service for the frontend application [Twix](https://github.com/Diaga/Twix) being developed for AppCon'19 by Telenor Microfinance Bank.
## Documentation
In four simple steps, you will be able to run this server on your own machine! Using PyCharm IDE is recommended, however, you can use your favorite Python IDE.
* Clone the git repository
* Install the required dependencies by running the following command:
```
pip install -r requirements.txt
```
* This project uses sqlite as database, therefore, there is no need for setup. Simply run migrations through following command:
```
python app/manage.py migrate
```
* Finally, run the last command and the API will be accessible on your machine through 127.0.0.1:8000:
```
python app/manage.py runserver
```
You can visit 127.0.0.1:8000/api for a list of available endpoints.
## Django Admin
You can leverage the power of django admin to have an overview of this project.
* Create a superuser using the following command:
```
python app/manage.py createsuperuser
```
* You can now login using the details entered in the above command at 127.0.0.1:8000/admin
## External Link
This project is hosted at [here](https://api.knctu.com/api) for AppCon'19.
## Dependencies
Twix Server has the following dependencies:
* [Django](https://github.com/django/django)
* [Django REST Framework](https://github.com/encode/django-rest-framework)
* [fcm-django](https://github.com/xtrinch/fcm-django)