https://github.com/vidalguilherme/todo-list-spring

Spring boot Java Postgres Todo List sample API RESTful
https://github.com/vidalguilherme/todo-list-spring

Last synced: about 2 months ago
JSON representation

Spring boot Java Postgres Todo List sample API RESTful

• Host: GitHub
• URL: https://github.com/vidalguilherme/todo-list-spring
• Owner: VidalGuilherme
• Created: 2024-01-28T21:32:36.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-01-28T21:34:23.000Z (12 months ago)
• Last Synced: 2024-01-28T22:32:38.353Z (12 months ago)
• Language: Java
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple To Do List API RESTful         

This repository contains a simple API RESTful project built using Java Spring. The aim of this repository is to practice and share how you can build a API using Java Spring.

## Table of Contents

- [Installation](#installation)

- [Configuration](#configuration)

- [API Endpoints](#api-endpoints)

- [Database](#database)

## Installation

1. Clone the repository:

```bash

$ git clone [email protected]:VidalGuilherme/todo-list-spring.git

```

2. Install dependencies with Maven

## Usage

1. Start the application with Maven

2. The API will be accessible at http://localhost:8080/api/

## API Endpoints

The API provides the following endpoints:

### TODO LISTS

```markdown

GET /todo_lists - Retrieve a list of all todo lists.

POST /todo_lists - Register a new todo list.

PUT /todo_lists/{id} - Alter an existing todo list.

DELETE /todo_lists/{id} - Delete an existing todo list.

```

### TODO ITEMS

```markdown

GET /todo_items - Retrieve a list of all todo items.

POST /todo_items - Register a new todo item.

PUT /todo_items/{id} - Alter an existing todo item.

DELETE /todo_items/{id} - Delete an existing todo item.

```

## Database

The project uses PostgresSQL as the database.

Spring boot to automatically load my database schema when I start it up

```markdown

spring.jpa.generate-ddl=true

```

## Docker

You can run a database for this project with Docker by running the following command:

```bash

$ docker-compose up -d

```

To install Docker locally you can [click here](https://www.docker.com/products/docker-desktop/).