Project (backend + frontend submodule)

Locations

• Backend: src/main/java
• Frontend: src/main/webapp (git submodule)
• Documentation: http://localhost:8080/api/docs (requires development server)

Development

1. Install the dependencies

• OpenJDK 17

2. Clone the backend only

git clone https://github.com/uji-disnote/app.git

3. Change the working directory

cd app

4. Start the backend development server

   Linux / MacOS

   ./mvnw quarkus:dev
   

   Windows (PowerShell)

   .\mvnw.cmd quarkus:dev
   

   Windows (CMD)

   mvnw.cmd quarkus:dev
   

Production

1. Install the dependencies

• Docker

2. Clone the project including submodules

git clone --recurse-submodules https://github.com/uji-disnote/app.git

3. Change the working directory

cd app

4. Compile the project to a docker image (aprox. 10 min)

docker build -t uji-disnote/app .

5. Start the project docker image (temporary)

docker run -it --rm -p 8080:8080 uji-disnote/app

Repositories

• Backend: uji-disnote/app
• Frontend: uji-disnote/webapp