Skip to content

mitwelten/mitwelten-bricks-app

Repository files navigation

mitwelten-bricks-app

About the Project

This project is used to test scenarios with distributed sensors and actuators. Therefore, the sensors and actuators communicate either via the Internet with the application or are simulated by it. The goal is to create a test environment to develop algorithms, such as for a guidance system. screenshot

Built With

The following technologies were used for the implementation of the project:

Dependencies

The application needs dependencies from maven central. However, it also has local dependencies, which you can find in the libs folder.

Testing

Getting Started

Prerequisites

Make sure, you have the following installed:

  • Java 17 or newer
  • Gradle 8

Check out the Source Code from GitHub.

git clone https://github.com/mitwelten/mitwelten-bricks-app.git

Run the application:

gradle run

Clean up

To clean up the build folder:

gradle clean 

Testing

Run the tests:

gradle test

Documentation

Architecture

The architecture is implemented according to the MVC architecture pattern. For this purpose, the application was implemented using the JavaFX MVC template from the University FHNW. For more information see JavaFX MVC-Template.

Project Structure

/
├─── artifactory.gradle           (settings for repo.webis.de: do not touch)
├─── bin/                         (compiled binaries; not committed, in .gitignore)
├─── build/                       (generated build files; not committed, in .gitignore)
├─── build.gradle                 (project settings)
├─── .gitignore
├─── gradle/                      (Gradle distribution to build this project)
├─── .gradle/                     (not committed, in .gitignore)
├─── gradlew                      (Unix command for Gradle)
├─── gradlew.bat                  (Windows command for Gradle)
├─── libs                         (Local dependencies)
├─┬─ src/                         (Source Code)
│ ├─┬─ main/
│ │ ├─── java/                    (Java classes)
│ │ └─── resources/               (Resources used by the Java classes)
│ └─┬─ test/
│   └─── java                     (Java test classes)
├─── Readme.md
├─── LICENCE 
└─── settings.gradle              (project name configuration)

Reference Documentation

For further reference, please consider the following sections:

License

This project is licensed under the MIT License. Feel free to modify and distribute it as needed.

Contact

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published