SimpleTodo

A simple Todo Tracker

Requirements

To run this application you need to have at least Java 8, Maven and Docker installed:

To install Maven:

sudo apt-get install mvn

First start the MySQL database with docker-compose.

Navigate to the working directory and run:

docker-compose up

After that let Maven compile our Application

mvn clean install

After that you can run the Application by executing the compiled jar:

java -jar target/SimpleTodo-0.0.1-SNAPSHOT.jar

The Application will be reachable at port 8080:

http://localhost:8080/

This Application implements a simple Web Application with a REST API. The following API calls are implemented.

GET http://localhost:8080/todos     #returns a list of all TODOS as JSON
GET http://localhost:8080/todos/id  #returns the TODO with the given ID

The body of the POST-requests needs to be a JSON with a TODO object with the necessary key-value pairs. You can find the JSON format here.

POST http://localhost:8080/todos     #Adds a TODO

The body of the PUT-requests needs to be a JSON with a TODO object with the necessary key-value pairs. You can find the JSON format here.

PUT http://localhost:8080/todos/id  #Edits/Updates the TODO with the given ID

DELETE http://localhost:8080/todos/id  #Deletes the TODO with the given ID

{
    "id": "1",
    "description": "Einkaufen gehen",
    "deadline": "1.1.2011",
    "percentage": "0"
}

Import this project as a Maven project.

For IntelliJ IDEA:

Open -> direct to Project Folder -> choose pom.xml -> click on Open as Project