README.md

Whiskey o' clock

Project for the course Advanced Software Engineering @ DHBW Karlsruhe
Explore the documentation »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

Project for the course Advanced Software Engineering @ DHBW Karlsruhe

(back to top)

Built With

• Spring Boot
• Angular

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• IDE, which supports Maven Projects for the Backend
• IDE, which supports NPM for the Frontend

Installation - Backend

1. Clone the repo

   git clone https://github.com/Unk3wn/AdvancedSoftwareEngineering.git

   
2. Import the Project from the Folder /1 - Backend - Spring - Clean Architecture/ into your IDE
3. Download the needed Maven Dependenciess to run the Project

   mvn install

   
4. Start the Backend in your IDE by Executing the main Method in the Class 'WhsikeyOClockApplication.java'

Installation - Frontend

1. Clone the repo

   git clone https://github.com/Unk3wn/AdvancedSoftwareEngineering.git

   
2. Import the Project in the Folder /2 - Frontend - Angular/ into your IDE
3. Download the needed Node Dependencys to run the Project

   npm install

   
4. Start the Frontend in your IDE by Executing the start Method in the Json File 'package.json'
5. Access https://localhost:4200 on your Browser to view the Frontend

(back to top)

Usage

Backend

• Swagger
• H2Console

Frontend

• Frontend Angular

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Project Link: https://github.com/Unk3wn/AdvancedSoftwareEngineering/

(back to top)