Skip to content

just-fine1/AnnotationTemplates

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Annotation Management System

Description of the project

This project provides a simple REST API built with Spring Boot to manage “Annotations” — records that contain a unique shortcut, issue category, article reference, solution description, priority level, and an associated email template.
It allows clients to create, update, retrieve and delete annotations, along with linking to pre-defined email templates. The system is designed for demonstration and learning purposes.

img.png

Setup

Prerequisites:

  • Java JDK 17
  • Maven or Gradle
  • A relational database (e.g., MySQL, PostgreSQL, H2 for in-memory)
  • IntelliJ IDEA (optional, but recommended)

Technologies Used • Spring Boot • Spring Data JPA • Hibernate ORM • Lombok • H2 (or MySQL/PostgreSQL) • IntelliJ IDEA • Maven (or Gradle) • Java 17

Controllers and Routes structure


HTTP Method:POST

Route:/api/annotation/create

Description:Create a new Annotation


HTTP Method:GET

Route:/api/annotation/list

Description:List all Annotations


HTTP Method:GET

Route: /api/annotation/shortcut/{shortcut}

Description: Retrieve an Annotation by shortcut


HTTP Method:PUT

Route: /api/annotation

Description: Update an existing Annotation


HTTP Method: DELETE

Route: /api/annotation/shortcut/{shortcut}

Description: Delete an Annotation by shortcut


Extra links

Prezio: https://prezi.com/view/T512jN8oYSOKEt02J3Av/?referral_token=Tlua5GlnB3FN

Future Work

Front-End

Artificial intelligence

Resources

Ironhack Youtube

Team members

Mithurshan Mahendran

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages