starkey/notesvault
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add system overview

Browse Source
This commit is contained in:
Sean Starkey
2026-06-02 08:52:08 -06:00
parent 357f179644
commit d881388969
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,5 +1,17 @@
# Secure Notes Vault API # 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 ## Running the program
This project requires Java 21 and Maven. The API starts on `http://localhost:8080`. This project requires Java 21 and Maven. The API starts on `http://localhost:8080`.