Sem descrição

Daniel Bohry c2f5fbfbc7 fix bug where user public note cannot be accessed by others há 9 meses atrás
.github 7711311f90 add deploy step to pipeline há 9 meses atrás
gradle df39d1962b first commit há 10 meses atrás
src c2f5fbfbc7 fix bug where user public note cannot be accessed by others há 9 meses atrás
.gitattributes df39d1962b first commit há 10 meses atrás
.gitignore 1dd00b5fdf update logo há 10 meses atrás
Dockerfile df39d1962b first commit há 10 meses atrás
README.md f4f0f71cf7 update readme há 10 meses atrás
build.gradle 114c0f92f6 feat: add integration tests for NoteController (#4) há 9 meses atrás
gradlew a5cffc6e8c add frontend há 10 meses atrás
gradlew.bat df39d1962b first commit há 10 meses atrás
settings.gradle df39d1962b first commit há 10 meses atrás
test-workflow.sh 108b8cf2b4 fix app release workflow há 9 meses atrás

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