https://github.com/asis2016/api-django-basic-todo
A Basic TODO App is made up of Django REST framework.
https://github.com/asis2016/api-django-basic-todo
django django-rest-framework python rest-api swagger
Last synced: about 2 months ago
JSON representation
A Basic TODO App is made up of Django REST framework.
- Host: GitHub
- URL: https://github.com/asis2016/api-django-basic-todo
- Owner: asis2016
- Created: 2021-06-03T15:49:07.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-04T15:01:15.000Z (almost 5 years ago)
- Last Synced: 2025-06-01T18:41:35.066Z (about 1 year ago)
- Topics: django, django-rest-framework, python, rest-api, swagger
- Language: CSS
- Homepage: https://api-basic-todo-amaharjan.herokuapp.com/api-auth/login/?next=/api/v1/
- Size: 1.87 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A Basic TODO App
A Basic TODO App is made up of Django REST framework.
## Tech Stack
Docker 20.10.6, Python 3.8, Django 3.2.3, Django REST framework, Whitenoise, Gunicorn, Heroku
## Run Locally
Clone the project
```bash
git clone https://github.com/asis2016/api-django-basic-todo.git
```
Go to the project directory
```bash
cd api-django-basic-todo
```
Start the project
```bash
docker build .
```
```bash
docker-compose up -d --build
```
## Running Tests
To run tests, run the following command
```bash
docker-compose exec web python manage.py test
```
## Environment Variables
`SECRET_KEY` `django-insecure-*b-vg)^t=m2dtax_17)!zzbxmthz+o+p&^=k9_+)awgjy9(!l+`
## Django REST framework Docs
[/docs/](https://api-basic-todo-amaharjan.herokuapp.com/docs/)
### Django REST framework login API Login (as admin)
[/api-auth/login/?next=/api/v1/](https://api-basic-todo-amaharjan.herokuapp.com/api-auth/login/?next=/api/v1/)
- username: admin
- password: admin
## API Reference
#### Get all todos
```http
GET /api/v1/
```
| Parameter | Type
| :-------- | :-------
| `api_key` | `string`
#### Get todo
```http
GET /api/v1/${uuid}
```
| Parameter | Type
| :-------- | :-------
| `uuid` | `string`
## Screenshots
### Django Administrator
[/admin/login/?next=/admin/](https://api-basic-todo-amaharjan.herokuapp.com/admin/login/?next=/admin/)
### Django REST framework login API Login (as admin)
[/api-auth/login/?next=/api/v1/](https://api-basic-todo-amaharjan.herokuapp.com/api-auth/login/?next=/api/v1/)
### api/v1
[/api/v1/](https://api-basic-todo-amaharjan.herokuapp.com/api/v1/)
### /api/v1/uuid
[/api/v1/076c5ced-b976-4835-9509-c82ec646b041](https://api-basic-todo-amaharjan.herokuapp.com/api/v1/076c5ced-b976-4835-9509-c82ec646b041)
### api/v1/rest-auth/registration/
To register as an user, register from the link below
[api/v1/rest-auth/registration/](https://api-basic-todo-amaharjan.herokuapp.com/api/v1/rest-auth/registration/)
## Feedback
If you have any feedback, please reach out to us at hello@amaharjan.com