Skip to content

ernestorbemx/TodoApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Todo App

Implementation of a simple yet useful application for organizing incoming activities. This repo includes a client agnostic API Rest created using Spring Boot.

Table of Contents

Caveats

This application is using in-memory storage for data. No persistence layer is configured.

Endpoints

These are the endpoints implemented by the current version of the project.

Screenshot

Features

  • Create Todo (Text, Priority, Due Date)
  • Update Todo (Text, Priority, Due Date)
  • Update Todo Status (Done/Undone)
  • Delete Todo
  • Get Todos (Paginated, Sorted and Filtered)
  • Show real time completion stats

Prerequisites

There's no need for an specialized IDE for this project. However, since the development was done using IntelliJ IDEA, using it is super recommendable.

The needed software to run this project is:

  • OpenJDK 17+
  • Maven 3.9+

Installation

Please be sure that you have the software requirements as Prerequisites says.

Instructions to get your project up and running locally (UNIX-like systems):

  1. Clone Repo
git clone https://github.com/ernestorbemx/TodoApp.git
  1. Change directory to the cloned project folder
cd TodoApp
  1. Run maven script
./mvnw spring-boot:run
  1. Navigate to http://localhost:9090/swagger-ui/index.html#/
  2. Done!

Usage

This is a simple REST API. You can use your favourite HTTP client to start using it.

Testing

After following this instructions, you can run the script:

    ./mvnw test

Contributing

Contributions are welcome! For requesting changes, first open an issue.

When developing changes, please:

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/FeatureName)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Push to the branch (git push origin feature/FeatureName)
  5. Open a Pull Request

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages