diff --git a/README.md b/README.md new file mode 100644 index 0000000..e87f83d --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +## Features + +- **Create:** Create a new task by providing a title and a description. +- **View:** View all existing tasks. +- **Details:** View details of a specific task by its ID. +- **Update:** Update details of an existing task. +- **Delete:** Delete an existing task by its ID. + +## How it Works + +The application follows an MVC (Model-View-Controller) architecture model. Tasks are managed through controllers that interact with the task service and task repository to perform CRUD (Create, Read, Update, Delete) operations. + +## Installation and Usage + +1. **Clone this repository to your local machine.** +2. **Import the project into your preferred Java IDE.** +3. **Run the application as a Spring Boot application.** +4. **Access the application through your web browser at `http://localhost:8080`.** + +## Useful Links + +- [Code Documentation](https://taskmanagerappdocumentation.netlify.app/): Here you can find detailed documentation of the project's source code. +- [Report a Problem](https://www.linkedin.com/in/vanina-a-godoy/?locale=en_US): If you encounter any issues or have suggestions for improvement, please report them here. + +## Contact + +If you have any questions or need assistance with the project, feel free to contact me: + +- **LinkedIn:** [Vanina Godoy](https://www.linkedin.com/in/vanina-a-godoy/?locale=en_US)