https://github.com/apsarawitharana/aad-spring-note-taker

Lesson AAD Spring In class Project
https://github.com/apsarawitharana/aad-spring-note-taker

java spring

Last synced: about 15 hours ago
JSON representation

Lesson AAD Spring In class Project

• Host: GitHub
• URL: https://github.com/apsarawitharana/aad-spring-note-taker
• Owner: ApsaraWitharana
• License: mit
• Created: 2024-08-18T07:26:26.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-29T07:58:13.000Z (3 months ago)
• Last Synced: 2024-11-11T11:50:09.825Z (about 2 months ago)
• Topics: java, spring
• Language: Java
• Homepage:
• Size: 170 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Note Tracker - Spring Boot Application Class Project - AAD- GDSE68

This is a Spring Boot application designed for tracking user notes, which allows full CRUD operations (Create, Read, Update, Delete) for both `User` and `Note`. The project is integrated with MySQL for database management, supports comprehensive exception handling, and includes health check endpoints. Postman is used for API testing.

## Features

- **User Management**: Perform CRUD operations for `User`.

- **Note Management**: Perform CRUD operations for `Note`.

- **Health Check**: Check if the application is running properly.

- **Error Handling**: Custom exceptions for better error messages and debugging.

- **Postman Testing**: API testing is done via Postman for all CRUD operations.

## Technology Stack

- **Backend**: Spring Boot

- **Database**: MySQL

- **Testing**: Postman

- **Build Tool**: Maven

- **Java Version**: 17

- **Dependencies**:

  - Spring Boot Starter Web

  - Spring Boot Starter Data JPA

  - MySQL Driver

  - Spring Boot DevTools (Optional)

  - Spring Boot Actuator (For Health Check)

  - Spring Boot Starter Validation (For error handling)

## Prerequisites

- **Java 11** or higher installed

- **Maven** installed

- **MySQL** installed and running

- **Postman** installed for API testing

## Setup Instructions

### MySQL Database Configuration

1. Create a new database in MySQL:

   ```sql

   CREATE DATABASE notetracker;

   CREATE TABLE noteTraker (

    noteId VARCHAR(15) PRIMARY KEY,

    noteTitle VARCHAR(255) NOT NULL,

    noteDesc VARCHAR(255) NOT NULL,

    priorityLevel VARCHAR(255) NOT NULL,

    createDate BIGINT NOT NULL 

### post man document- https://documenter.getpostman.com/view/35385905/2sAXjF8aZW