TodoX

Content

[[TOC]]

Team

• Minh Dang - [email protected]
• Sviatoslav Vasev - [email protected]

Project description

Idea

For this work the goal is to program a "RG (random generated) TODO app". In short:

• Express backend generates random tasks from a REST API endpoint.
• Nextjs frontend with a simple TODO-app where initial tasks are fetched from the backend.

Access

Frontend

http://21wsp4pw.course.tamk.cloud

Backend

http://21wsp4pw.course.tamk.cloud/api

Database

• Create a new to-do list POST http://21wsp4pw.course.tamk.cloud/api/v1/task/list
• Update an existing to-do list by its id PUT http://21wsp4pw.course.tamk.cloud/api/v1/task/list/:id
• Find an existing to-do list by its id GET http://21wsp4pw.course.tamk.cloud/api/v1/task/list/:id Example:

{
  "tasks": [
    {
      "task": "go somewhere",
      "done": true
    },
    {
      "task": "go somewhere else",
      "done": false
    }
  ]
}

Technology

Frontend

• Nextjs
• TailwindCSS

Backend

• Node.js
• Express
• Docker
• faker.js

Roadmap

[+ [0.1.0] +]

• Frontend is initialized and is running on localhost:3000
• Backend is initialized and is running on localhost:5000

[+ [0.2.0] +]

• Frontend is running in Docker and is accessible on localhost:3000
• Backend is running in Docker and is accessible on localhost:5000

[+ [0.3.0] +]

• Frontend is running in CI Docker and is accessible on http://21wsp4pw.course.tamk.cloud
• Backend is running in CI Docker and is accessible on http://21wsp4pw.course.tamk.cloud/api

[+ [0.4.0] +]

• Backend returns single random generated todo-task from http://21wsp4pw.course.tamk.cloud/api/v1/task/random endpoint.
• Frontend lists 3 random tasks in a todo-list UI. Each item in the list has a text field that describes the task, and a checkbox to mark the item done.
• User can add, delete and mark tasks done.

[+ [0.5.0] +]

• Frontend has at least 3 custom tests that are passing both in localhost and pipeline.
• Backend has at least 3 custom tests that are passing both in localhost and pipeline.

[+ [0.6.0/1.0.0] +]

• New backend endpoints:
  • POST /api/v1/task/list:
  • GET /api/v1/task/list/:id: Returns a list of tasks by ID number.
  • PUT /api/v1/task/list/:id: Updates the list content.
• Frontend functionality:
  • "Save new" button to save the current TODO list using the backend.
  • "Load" button that is used to load saved lists from the backend.
  • "Update" button to overwrite existing list with what is currently active in the UI.