Keine Beschreibung

Daniel Bohry 3ea96f2a0f disable tests vor 9 Monaten
.github 7711311f90 add deploy step to pipeline vor 9 Monaten
gradle df39d1962b first commit vor 10 Monaten
src 3ea96f2a0f disable tests vor 9 Monaten
.gitattributes df39d1962b first commit vor 10 Monaten
.gitignore 1dd00b5fdf update logo vor 10 Monaten
Dockerfile df39d1962b first commit vor 10 Monaten
README.md f4f0f71cf7 update readme vor 10 Monaten
build.gradle 114c0f92f6 feat: add integration tests for NoteController (#4) vor 9 Monaten
gradlew a5cffc6e8c add frontend vor 10 Monaten
gradlew.bat df39d1962b first commit vor 10 Monaten
settings.gradle df39d1962b first commit vor 10 Monaten
test-workflow.sh 108b8cf2b4 fix app release workflow vor 9 Monaten

README.md

kNotes

A modern, efficient note-taking application with automatic compression, dark mode theming, and mobile-responsive design.

Quick Start

Prerequisites

  • Java 25 or higher
  • MongoDB

Running the Application

  1. Build the application

    ./gradlew build
    
  2. Run the application

    ./gradlew bootRun
    
  3. Access the application

    • Open your browser to http://localhost:8080
    • Start typing to create your first note!

API

Note Endpoints

Method Endpoint Description
GET /api/notes/{id} Retrieve a note by ID
POST /api/notes Create a new note
PUT /api/notes Update an existing note

Request/Response Examples

Create Note:

POST /api/notes
Content-Type: application/json

{
  "note": "Your note content here"
}

Response:

{
  "id": "01KDECFWYDMS857DZMCR680MCY",
  "content": "Your note content here",
  "createdAt": "2024-12-27T10:30:00Z",
  "modifiedAt": "2024-12-27T10:30:00Z"
}

Testing

Run the test suite:

./gradlew test

Test categories:

  • Unit tests for compression utilities
  • Integration tests for Note entity
  • Service layer tests for business logic

Configuration

MongoDB Configuration

The application uses MongoDB for storage. Configure connection in application.properties:

spring.data.mongodb.uri=mongodb://localhost:27017/knotes

Live

https://notes.lhamacorp.com/01KDFNNWYG2MJR2TD9F0384T3N