https://github.com/marcusbello/polling_app
Poll API - django rest framework
https://github.com/marcusbello/polling_app
authentication django drf postgresql python rest-api
Last synced: 3 months ago
JSON representation
Poll API - django rest framework
- Host: GitHub
- URL: https://github.com/marcusbello/polling_app
- Owner: marcusbello
- Created: 2023-06-05T08:28:23.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T07:53:33.000Z (over 2 years ago)
- Last Synced: 2025-12-26T06:21:36.176Z (6 months ago)
- Topics: authentication, django, drf, postgresql, python, rest-api
- Language: JavaScript
- Homepage: https://polling-app-kappa.vercel.app
- Size: 14.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Polling App
- - -
### Features
- User authentication
- Add Polls
- Add Choices for each polls
- Record votes for each choice on the poll
- Read Polls with all the associated data
- JWT authentication and authorization
### Documentation
1. JSON API specification at /swagger.json
2. YAML API specification at /swagger.yaml
3. Swagger UI API specification at /swagger/
4. ReDoc API specification at /redoc/
### Endpoints
| URL | HTTP Verb | Functions |
|---------------------------|-----------|----------------------------------------|
| 'user/login' | POST | user login |
| 'user/' | POST | user registration |
| '/polls' | GET | return all polls |
| '/polls/{id}' | GET | get specified ID poll |
| '/polls/{id}/choices' | GET | get choices from specified poll |
| '/polls/{id}/choices/{choice_id}/vote' | GET | returns votes belonging to each choice |
### Tool
1. Python
2. Django & Django Rest Framework
3. Postgres (Unplugged for dev)
### Run local
- create virtual environment `python3 -m venv venv`
- activate virtual env `. venv/bin/activate`
- install requirements.txt `pip install -r requirements.txt`.
- run application `python manage.py runserver`
- run tests `python manage.py test`