From d8813889693d2c1738b312c6d02c1cd44a4ac6c4 Mon Sep 17 00:00:00 2001 From: Sean Starkey Date: Tue, 2 Jun 2026 08:52:08 -0600 Subject: [PATCH] Add system overview --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index f367042..e33633c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # Secure Notes Vault API +## System overview + +Secure Notes Vault API is a Spring Boot REST service for creating, managing, and sharing private notes. Users register and log in with username/password credentials, then authenticate subsequent requests with a JWT bearer token. + +The application is organized around a standard controller-service-repository flow: + +- Controllers expose the authentication and notes REST endpoints. +- Spring Security and a JWT filter authenticate protected requests. +- Services enforce note ownership and read-only shared-note access rules. +- JPA repositories persist users, notes, and note shares. +- Flyway migrations manage the database schema for both local H2 and PostgreSQL-backed runs. + ## Running the program This project requires Java 21 and Maven. The API starts on `http://localhost:8080`.