https://github.com/eddypbr/todolist-api
☕ Java Spring TodoList: A simple task management application built with Spring Boot.
https://github.com/eddypbr/todolist-api
crud java javaapplication spring springboot springdatajpa springframework taskmanagement todolist webapplication
Last synced: about 1 month ago
JSON representation
☕ Java Spring TodoList: A simple task management application built with Spring Boot.
- Host: GitHub
- URL: https://github.com/eddypbr/todolist-api
- Owner: EddyPBR
- License: mit
- Created: 2023-10-09T14:44:43.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-15T19:40:14.000Z (over 1 year ago)
- Last Synced: 2023-10-16T15:39:45.568Z (over 1 year ago)
- Topics: crud, java, javaapplication, spring, springboot, springdatajpa, springframework, taskmanagement, todolist, webapplication
- Language: Java
- Homepage:
- Size: 92.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Java Spring TodoList Project
A simple TodoList application built using Java and Spring Boot.
## Features
- Create, Read, Update, and Delete (CRUD) tasks.
- Mark tasks as completed.
- Organize tasks into categories.
- User-friendly interface for managing your tasks.
## Technologies Used
- Java
- Spring Boot
- Spring Data JPA
- Thymeleaf (or your preferred front-end technology)
- MySQL (or your preferred database)
- HTML, CSS, JavaScript (for front-end)
## Getting Started
1. Clone this repository.
2. Configure your database settings in `application.properties`.
3. Build and run the application.
4. Access the TodoList at `http://localhost:8080`.
## Using the REST Client Extension in Visual Studio Code
If you're a developer working on this project, testing the API endpoints is crucial. To make this process seamless, we recommend using the REST Client extension in Visual Studio Code (VSCode).
### Step 1: Install the REST Client Extension
1. Open Visual Studio Code.
2. Go to the Extensions view by clicking on the square icon on the left sidebar or pressing `Ctrl+Shift+X`.
3. Search for "REST Client" in the search bar.
4. Click the "Install" button for the REST Client extension provided by Huachao Mao.
5. After installation, you'll need to reload or restart VSCode to activate the extension.
### Step 2: Testing Endpoints
In this project, we've provided a `routes.http` file in the root directory. This file contains a set of sample requests to test the API endpoints of our application.
To use the `routes.http` file:
1. Open the `routes.http` file in VSCode.
2. You'll see a list of HTTP requests
3. Click on the "Send Request" button next to each request to execute it.
## Running the Dockerized Todo List Application
This repository contains a Dockerized Todo List application that you can easily run with Docker. Below are the steps to get it up and running on your system.
### Prerequisites
Before you begin, make sure you have the following prerequisites installed on your system:
- Docker: You can download and install Docker from the [official Docker website](https://www.docker.com/get-started).
### Build and Run the Docker Container
1. Clone this repository to your local machine:
```bash
git clone https://github.com/eddypbr/todolist-docker.git
## Usage
- Add new tasks with descriptions and due dates.
- Mark tasks as completed when they are done.
- Organize tasks into categories or tags.
- Edit or delete tasks as needed.
## Contributing
Contributions are welcome! Feel free to open issues or pull requests to improve this project.
## License
This project is open-source and available under the [MIT License](LICENSE).