Skip to content

Latest commit

 

History

History
199 lines (155 loc) · 5.49 KB

README.md

File metadata and controls

199 lines (155 loc) · 5.49 KB
Raw

Todo App Backend

A simple backend to manage an application to create, delete and edit Todo's

This app works with the frontend application found here: Frontend App

Requirements

For running this application you need:

Running the application locally

There are many ways to run a spring boot application, the simplest is t run the main method in the com.example.TodoBack.ToDoBackApplication class.

You can use the mvn command from the terminal inside the app folder:

mvn spring-boot:run

Running tests

There are some tests already configured in this application to make sure the main funcionalities work as expected

To run this tests you have to run the following command from the terminal:

mvn test

API Reference

These are the main endpoints used in this app

Get Items

GET /api/todos
Parameter Type Description Default
page number Min: 1
Page of the data you will get		 1
textFilter string Min Lenght: 1 Max Lenght: 120
All text without this string will be filtered		 ""
sortBy string[] The values that willbe considered when sorting data []
priorityOrder string The order used when ordering by priority ""
dueDateOrder string The order used when ordering by due date ""
priorityFilter string[] The objects with priorities different to the ones in this array will be ommited []
stateFilter string The objects with a different state than this one will be ommited ""

Returns PaginatedTodoDTO

Create item

POST /api/todos
Parameter Type Description
dto TodoItemDTO Body
The object you need

Returns TodoItem

Update item

POST /api/todos/:id
Parameter Type Description
id string The id of the object being updated
dto TodoItemDTO Body
The object you need

Returns TodoItem

Delete item

DELETE /api/todos/:id
Parameter Type Description
id string The id of the object being deleted

Returns TodoItem

Mark item as done

GET /api/todos/:id/done
Parameter Type Description
id string The id of the object being marked as done

Returns TodoItem

Mark item as undone

GET /api/todos/:id/undone
Parameter Type Description
id string The id of the object being marked as undone

Returns TodoItem

Examples

Here are some examples of the model used here

TodoItemDTO

{
  "text": "test",
  "done": false,
  "priority": "High",
  "dueDate": "2025-03-07T00:00:40.699+00:00",
  "doneDate": "2025-03-07T00:00:40.699+00:00"
}

TodoItem

{
    "id": "f2f1d98f-880f-45f3-8d2d-92af8c0f0717",
    "text": "test",
    "dueDate": "2035-03-07T00:00:40.699+00:00",
    "done": true,
    "doneDate": "2035-04-04T00:00:40.699+00:00",
    "priority": "Medium",
    "creationDate": "2024-07-08T00:21:40.699+00:00"
}

PaginatedTodoDTO

{
  "content": [
    {
      "id": "16c96dc8-3bc7-42b2-973a-b7b020f241da",
      "text": "test17",
      "dueDate": "2036-02-05T00:00:43.637+00:00",
      "done": false,
      "doneDate": null,
      "priority": "Low",
      "creationDate": "2024-07-08T04:10:43.638+00:00"
    },
    {
      "id": "3af398f2-30db-4c9d-9e2c-ab6c2ca7d321",
      "text": "test18",
      "dueDate": "2034-06-02T00:00:43.638+00:00",
      "done": false,
      "doneDate": null,
      "priority": "Medium",
      "creationDate": "2024-07-08T04:10:43.638+00:00"
    },
    ...
  ],
  "parameters": {
    "textFilter": "",
    "priorityFilter": [],
    "stateFilter": "",
    "sortBy": [],
    "prioritySortOrder": "DESC",
    "dueDateSortOrder": "DESC"
  },
  "averageData": {
    "generalAverage": 0,
    "lowAverage": 0,
    "mediumAverage": 0,
    "highAverage": 0
  },
  "currentPage": 1,
  "itemsInPage": 10,
  "totalPages": 2,
  "totalItems": 20,
  "allDone": false,
  "firstPage": true,
  "lastPage": false
}

Technologies used

The following tools were used to make this app:

Things to improve

  • Add capabilities for sorting using any value not just Priority and Due Date
  • Add more thorough tests