Skip to content

informatik-heilbronn/transparenz-cockpit

 
 

Repository files navigation

Transparent Cockpit

Transparenzcockpit is a database for project report organization with a database based on MongoDB and an online UI based on Next.js.

Basics

Find more Information here on our Confluence Page

Structure

This project is divided into two part the frontend and the backend.

Prerequisites

  • Docker & Docker-Compose (Docker Desktop)
  • Java 11 or newer
  • Node.js (optional)

Build

Build Frontend & Backend

gradle build

Build Frontend

gradle frontend:build

Technologies

A list of technologies used within the project:

Installation - Frontend

To run the web UI locally navigate to the frontend folder and run npm install followed by npm run dev.

Build Backend

gradle backend:build

Prerequisites

  • Docker & Docker-Compose Install (Docker Desktop)
  • Java 11 or newer

Requirements

To Start

docker-compose up -d

To Stop

docker-compose down

Test

gradle backend:test backend:checkstyleMain

Run

gradle backend:run