Skip to content

Latest commit

 

History

History
121 lines (76 loc) · 7.81 KB

README.md

File metadata and controls

121 lines (76 loc) · 7.81 KB
Raw

Taskfiy - Inteligent task planner

LIVE:

ABOUT PROJECT 💡 :

  • 🔨 Why did we build this project ?

    Our motivation we found in the problem while planing our tasks. We needed something that would plan and calculate stages of our tasks for us.

  • 🧑‍💻 How we found the solution ?

    So, we thought that is possible create a function which based on chooised by user start date and end date with help current date, will be calculate all needed informations and show data on charts. To sum up, the most important thing in all this are calculations based on 3 dates and after all calculations our application show user his progress, finished days, future days and how much he must to do in chooised task.

🙋‍♂️

AUTORS FRONTEND BACKEND
GabrielJuniorDev (Gabrli) 100% 0%
gental-py (gental-py) 0% 100%

🛠️ Tech stack

Frontend

  • React  React + Vite
  • TypeScript  TypeScript
  • CSS  Tailwindcss
  • HTML5  HTML5

Backend

  • Python3  Python3
  • FastAPI  FastAPI

Other tools

  • GIT Git - version control system

SCREENS:

1.Landing page:

- Dark mode:

  • Light mode:

2.Dashboard:

- Dark mode:

  • With Notifications:

API Server

Response:

Every response is in JSON format and has a "status" key with a boolean value.

When the value is True, the action succeeded,

  and additional data may be passed by response

  (check the DATA ON SUCCESS column for details).

When the value is False, the required action failed,

  and the response will contain "err_msg" with

  an error message in a displayable form.

All endpoints are POST methods

(except /accounts/getAllNames which is GET)

ENDPOINT INPUT DATA DATA ON SUCCESS
/accounts/login username, password uid: str
/accounts/register username, password, email uid: str
/accounts/delete uid -
/accounts/changePassword uid, new -
/accounts/getAllNames names: List[string]
/tasks/create uid, name, description, date_start, date_end, Optional: folder_key task_id: str
/tasks/edit uid, task_id name, description, date_start, date_end -
/tasks/remove uid, task_id -
/tasks/getAll uid tasks: List[object]
[{name, description, date_start, date_end, task_id}, {...},...]
/tasks/getTask uid, task_id task: object
{name, description, date_start, date_end, task_id}
/folders/create uid, name, color folder_key: str
/folders/get_folder uid, folder_key folder: object
{author: str, name: str, color: str, task_ids: List[str]}
/folders/update uid, folder_key, new_name, new_color -
/folders/remove uid, folder_key -
/folders/add_task uid, folder_key, task_id -
/folders/remove_task uid, folder_key, task_id -
Run server:

  1. Make sure You have Python and pip installed.

  2. Install all requirements: pip3 install -r requirements.txt

  3. Run API locally:

    python3 -m uvicorn api:api

  4. Deploy API:

    python3 -m uvicorn api:api --host 0.0.0.0 --port YOUR_PORT