esmond-adjei/streaker

Backend API for streakapp: A web app for marking your streaks towards the accommplishment of a goal

Streaker API

API for streakapp
Streakapp is a useful tool for keeping track of your daily tasks and habits ensuring you stay motivated to achieve your goals.

Installation

1. Clone the repo

git clone https://github.com/esmond-adjei/streaker.git

2. create a virtual environment

python -m venv venv

3. Install dependencies in a virtual environment

pip install -r requirements.txt

4. change directory into the project

cd streaker

5. Run the app

python manage.py runserver

API endpoints

Task

Endpoint	Method	Description	Status
/api/task/	GET	Get all tasks	✔️
/api/task/{id}	GET	Get a task by id	✔️
/api/task/{id}	PUT	Update a task by id	✔️
/api/task/{id}	DELETE	Delete a task by id	✔️

Streak

Endpoint	Method	Description	Status
/api/streak/	GET	Get all streaks	✔️
/api/streak/{id}	GET	Get a streak by id	✔️
/api/streak/{id}	PUT	Update a streak by id	✔️
/api/streak/{id}	DELETE	Delete a streak by id	✔️

User

Endpoint	Method	Description	Status
/api/user/register	POST	Register a new user	❌
/api/user/login	POST	Login a user	❌
/api/user/logout	POST	Logout a user	❌
/api/user/	GET	Get all users	❌
/api/user/{id}	GET	Get a user by id	❌
/api/user/{id}	PUT	Update a user by id	❌
/api/user/{id}	DELETE	Delete a user by id	❌