Skip to content
This repository has been archived by the owner on May 24, 2022. It is now read-only.

Latest commit

 

History

History
107 lines (77 loc) · 3.74 KB

README.md

File metadata and controls

107 lines (77 loc) · 3.74 KB
Raw

OSOC-6

Manual

A manual on how to use the tool is available as a pdf. It doesn't contain a lot of information since we have not yet started working on the front end.

Documentation

Documentation as proposed in the assignment document for each milestone.

Architecture

We constructed diagrams to clarify our code. Additionally, we supply use-cases, a domain-model (made in drawio) and a description of our API (made in swagger).

Deployment diagram

We provide an overview of the different layers, the technologies used within those layers and how they communicate in our deployment diagram.

Component overview

An overview and small description of our most important modules, the layers they are used in and the modules they communicate with is provided in our module overview.

Design

Besides class diagrams and interaction diagrams, we also provide a detailed documentation of our back end packages and Types. You can check this documentation in the browser by running npx serve in the backend-java-api folder.

Class diagrams

We provide class diagrams to show the structure of our most important classes.

Sequence Diagrams

In our sequence diagram you can see our most important object interactions.

Installation

Start by cloning the repository. Do this by pulling this project from GitHub. The easiest way is by just cloning the repository over https, but this might not work.

git clone https://github.com/SELab-2/OSOC-6.git

To fix this, we will need to clone via SSH. Go to your account settings (https://github.com/settings/keys) and add your public ssh key (~/.ssh/id_rsa.pub). Now we can use the following command to clone the repository.

git clone [email protected]:SELab-2/OSOC-6.git

Further setup is explained for front end and back end individually.

Test

Front end: 68.42% Back end: 100%

Backend test coverage is 100% and should be kept that way. Our frontend test coverage is not very high since we are prioritizing the implementation of all components first.

Team

  • Project leader: Jitse De Smet
  • System manager: Ruben Van Mello
  • API manager: Thomas Van Mullem
  • Test manager: Anne Depuydt
  • Documentation manager: Kasper Demeyere
  • Customer Relations Officer: Lukas Van Rossem

Developers

Developers information can be found in the dedicated documentation folder. We have documentation for back end, documentation for front end and documentation for server deployment.

Hooks

Running the hooks_creator.sh script will create hooks that makes git check your commits. This way you can already see if a commit works locally. We advise marking commits that fail with a commit message starting with (broken). A commit following this format will get tested but the commit will be executed regardless of the tests.

Git branch names

We think it's important to find a branch quickly, that's why we have rules regarding branch names in this project. The rules are described in #37. We use the following structure: {dir-name}/{issue-nr}-{description}. The dir-name is a name matching the label of the issue. We use following names:

  • management
  • feature-frontend
  • feature-backend
  • feature-databse
  • bugfix
  • documentation
  • test
  • refactoring