https://github.com/alimghmi/todev
A collaborative todo app for project management, enabling developers and project managers to work together on projects with custom permissions and JWT authentication.
https://github.com/alimghmi/todev
django djangorestframework djangorestframework-jwt docker gunicorn nginx python
Last synced: 2 months ago
JSON representation
A collaborative todo app for project management, enabling developers and project managers to work together on projects with custom permissions and JWT authentication.
- Host: GitHub
- URL: https://github.com/alimghmi/todev
- Owner: alimghmi
- License: mit
- Created: 2022-09-12T05:38:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-13T12:17:26.000Z (almost 4 years ago)
- Last Synced: 2026-01-03T22:57:18.320Z (6 months ago)
- Topics: django, djangorestframework, djangorestframework-jwt, docker, gunicorn, nginx, python
- Language: Python
- Homepage:
- Size: 335 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todev
## Summary
todev is a todo app with custom permission class defind for developers and project manager. They can collaborate with each other on different projects. Every authenticated user can create a project from scratch and become the project manager, add/remove developers to/from the project.
## ERD
## How to run
Simply via Docker:
```
git clone https://github.com/alimghmi/todev.git
cd todev
docke-compose -f docker-compose.dev.yaml up --build
```
Or Set it up manually:
```
git clone https://github.com/alimghmi/todev.git
cd todev/todev
python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py runserver
```
### Notes:
- docker-compose takes care of env files automatically. Consider adding **env variables** for a better experience, in case of manual setup.
- Please consider adding a *superuser* or create a non-super user via `signup` endpoint.
## Authorization
Todev leverages simple-jwt. All endpoints (except login/signup) expect you to send a access token as Authorization in the header.
## Testing
```
python3 manage.py test
```
## Browsable API
It's possible to test and examine the app within browser, which is provided by DRF UI. In addition following is possible to be managed via a third party app like curl by providing the brearer token as Authorization key in the request header.
## Endpoints
For further information please check **postman collection** of project, all necessarry fields of each endpoints are documented in details. Postman collection is available [here](https://github.com/alimghmi/todev/blob/master/doc/todev.postman_collection.json).
User-related operations:
```
POST /signup/: Create a new user
POST /api/token/: Return access/refresh tokens to login
```
Project endpoints:
```
GET /projects/: Return list of projects for user which user is a project manager or a developer of
POST /projets/: Create a new project by providing the needed fields
PUT /projects//: Update a project
GET /projects//: Get a detailed view of a project
DELETE /projects//: Delete a project
```
Task endpoints:
```
GET projects//tasks/: Get all of the tasks in a project
GET projects//tasks/?user=me: Get tasks of current logged in user in a project
GET projects//tasks/?user=: Get all of the tasks of in a porject
POST /tasks/: Add a new tasks to a project
PUT /tasks//: Update a task
DELETE /tasks//: Delete a task
```
## Endpoints Behavior
### Project Endpoint
- Every authenticated user can create a new project
- Creator of project is considered as Project Manager
- Project manager has full control over the project
- Developers' (members field) username must be sent on creation
- Developers have read-only access thus they can't update or remove a project
- Developers can retrieve user specific or all of the tasks of their project
- Projects show up when target user is either a project manager or a developer, otherwise they're not accessable
### Task Endpoint
- Project manager has full control over task creation and assigning them to developers
- A developer of project can add a task which will be automatically assigned to himself a.k.a developer doesn't have this right to assign a task to other developers
- Author of task (project manager or developer) can update or delete the task
- Assignees can update (delete not allowed) task status/name/description
## Recommended Improvements
- Endpoints to calculate developers performance
- Implementing cache system
- Custom user model to use email field as username
- Using a lint action on github