https://github.com/sandundil2002/note_taker_v1
This repository is RESTful API service designed to manage users & notes efficiently. Built with Spring & Maven, JPA and Hibernate this API leverages a MySQL database to provide CRUD operations for notes and users management.
https://github.com/sandundil2002/note_taker_v1
java jpa layered-architecture mysql rest-api spring web
Last synced: 2 months ago
JSON representation
This repository is RESTful API service designed to manage users & notes efficiently. Built with Spring & Maven, JPA and Hibernate this API leverages a MySQL database to provide CRUD operations for notes and users management.
- Host: GitHub
- URL: https://github.com/sandundil2002/note_taker_v1
- Owner: sandundil2002
- Created: 2024-08-18T06:52:38.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T04:31:41.000Z (over 1 year ago)
- Last Synced: 2025-03-18T09:14:14.369Z (over 1 year ago)
- Topics: java, jpa, layered-architecture, mysql, rest-api, spring, web
- Language: Java
- Homepage:
- Size: 130 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The Note Taker API is a comprehensive RESTful service designed to manage user notes efficiently. Built with Spring framework, JPA and Hibernate this API leverages a MySQL database to provide robust CRUD operations for notes and user management. It supports functionalities such as creating retrieving updating and deleting notes along with user profile management including profile picture uploads.
🧐 Features
Here're some of the project's best features:
* Create new notes
* View all notes
* View a specific note by ID
* Update existing notes
* Delete notes
* User management (create update delete users)
* File upload for user profile pictures
🛠️ Installation Steps:
1. Clone the repository:
```
git clone https://github.com/sandundil2002/Note_Taker.git
```
2. Navigate to the project directory:
```
cd Note_Taker
```
3. Install the required dependencies:
```
mvn install
```
4. Update the `application.properties` file with your MySQL database credentials:
```
spring.datasource.url=jdbc:mysql://localhost:3306/note_taker?createDatabaseIfNotExist=true spring.datasource.username=yourUsername spring.datasource.password=yourPassword
```
Postman API Documentation
💻 Built with
Technologies used in the project:
* Spring: For building the RESTful API and managing the application configuration.
* Spring MVC: For handling web requests and responses.
* Spring Data JPA: For data persistence and interaction with the MySQL database.
* Hibernate: As the ORM framework to map Java objects to database tables.
* MySQL: As the relational database to store user and note data.
* Maven: For project management and dependency management.