https://github.com/sergej-stk/notekeeper

This Java Spring Boot web interface allows users to create, retrieve, and edit notes. It provides a simple and efficient solution for managing personal or shared notes.
https://github.com/sergej-stk/notekeeper

docker expressjs java maven rest-api spring-boot typescript vue vuetify

Last synced: 3 days ago
JSON representation

This Java Spring Boot web interface allows users to create, retrieve, and edit notes. It provides a simple and efficient solution for managing personal or shared notes.

• Host: GitHub
• URL: https://github.com/sergej-stk/notekeeper
• Owner: sergej-stk
• License: apache-2.0
• Created: 2024-09-26T06:30:48.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-12-08T14:10:33.000Z (about 2 months ago)
• Last Synced: 2024-12-08T15:19:21.573Z (about 2 months ago)
• Topics: docker, expressjs, java, maven, rest-api, spring-boot, typescript, vue, vuetify
• Language: TypeScript
• Homepage: https://sergej-stk.github.io/notekeeper/
• Size: 64.3 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Notekeeper - Webservice

![License](https://img.shields.io/github/license/sergej-stk/notekeeper?style=flat-square&color=green")

![build](https://img.shields.io/github/actions/workflow/status/sergej-stk/notekeeper/main.yml?branch=main")

![language](https://img.shields.io/github/languages/top/sergej-stk/notekeeper)

NoteKeeper is a SpringBoot REST API designed for managing notes. It provides endpoints for creating, editing, deleting, and retrieving notes. The project also includes a Vue.js-based frontend, offering a user-friendly interface to interact with the API.

![Frontend](/assets/preview/frontend.png)

[API Reference](https://sergej-stk.github.io/notekeeper/)

## Run Locally (Linux)

Install Maven

```CMD

sudo apt install maven

````

Install Nodejs (Linux):

```CMD

sudo apt install nodejs

````

Clone Repository:

```CMD

git clone https://github.com/sergej-stk/notekeeper.git

````

Install Maven dependencies:

```CMD

cd notekeeper

mvn install

````

Compile jar file:

```CMD

cd notekeeper

mvn package

````

Install Nodejs dependencies:

```CMD

cd notekeeper/frontend

npm install

````

Compile vuejs:

```CMD

cd notekeeper/frontend

npm run build

````

## Authors

- [@sergej-stk](https://github.com/sergej-stk)

- [@kissmannchristoph](https://github.com/kissmannchristoph)