Skip to content

README.md

Latest commit

 

History

History
89 lines (67 loc) · 2.22 KB

README.md

File metadata and controls

89 lines (67 loc) · 2.22 KB

Todo List Application

Welcome to my project! This is the backend for a Todo List application that allows users to create, read, update, and delete tasks. The application is built using Spring Boot and DynamoDB. The frontend will be built using React.js. With this App, users can effortlessly manage their tasks and events, helping them stay organized and on top of their to-do list.

Technologies Used

  • Java
  • Spring Boot
  • DynamoDB
  • Postman

Features

  • Create tasks
  • Read tasks
  • Update tasks
  • Delete tasks

Getting Started

To run the application locally, follow these steps:

  1. Clone the repository
  2. Install Java and Maven
  3. Configure your AWS credentials and region in the application.properties file
  4. Run the application using the mvn spring-boot:run command

Usage

To use the application, you can send HTTP requests to the API using a tool like Postman. Here are the available endpoints:

  • GET /api/todo: Get all tasks
  • POST /api/todo: Create a task
  • GET /api/todo/{id}: Get a task by ID
  • PUT /api/todo/{id}: Update a task by ID
  • DELETE /api/todo/{id}: Delete a task by ID

Examples

Here are some examples of HTTP requests you can make to the API using Postman:

  • Get all tasks:

    • Method: GET
    • URL: http://localhost:8080/api/todo

  • Create a task:

    • Method: POST

    • URL: http://localhost:8080/api/todo

    • Body:

      jsonCopy code

      { "title": "Buy groceries", "description": "Buy milk, bread, and eggs", "completed": false }

  • Get a task by ID:

    • Method: GET
    • URL: http://localhost:8080/api/todo/1

  • Update a task by ID:

    • Method: PUT

    • URL: http://localhost:8080/api/todo/1

    • Body:

      jsonCopy code

      { "title": "Buy groceries", "description": "Buy milk, bread, and eggs", "completed": true }

  • Delete a task by ID:

    • Method: DELETE
    • URL: http://localhost:8080/api/todo/1

Future Improvements

  • Add authentication and authorization
  • Add pagination to the GET all tasks endpoint
  • Add sorting to the GET all tasks endpoint