aariv/notesapp

A secure and scalable RESTful API that allows users to create, read, update, and delete notes.

NotesApp

Stack

File structure

How to use this code?

1. Make sure you have Java 17 and above and Maven installed
2. Create Database

$ psql -U postgres (Enter your password)
$ CREATE DATABASE note;

3. Fork this repository and clone it

$ git clone https://github.com/Aariv/NotesApp

3. Navigate into the folder

$ cd NotesApp

4. Install dependencies

$ mvn clean install

5. Run the project

$ mvn spring-boot:run

6. Navigate to http://localhost:8080/swagger-ui.html in your browser to check everything is working correctly. You can change the default port in the application.yml file

server:
  port: 8080

Swagger UI

Build to Docker daemon Jib can also build your image directly to a Docker daemon. This uses the docker command line tool and requires that you have docker available on your PATH.

mvn compile jib:dockerBuild