mirante

Mirante is a data-oriented educational system that aims to minimize the loss of relevant data that could bring more insight into how we learn.

This repository contains the Java source code and the associated documentation.

Getting it

Pre-built binaries are available on certain milestone versions. See the releases for the available tags or go straight to the latest one.

If you would like to build it yourself, first clone or download this repository.

Once you are in the root of your local copy, you can use the included gradlew wrapper file to build:

./gradlew build

This will build Java .jar files in the build/libs directory.

Running

You will need a Java runtime or JDK to run Mirante.

Once you have downloaded or built a .jar file, you can start the server using:

java -jar build/libs/mirante-<version>.jar

Replace <version> with the current version, for example: java -jar build/libs/mirante-0.3.0-SNAPSHOT.jar.

If you are unsure about the current version number, look into the build/libs directory for what files were generated, or check the build.gradle file for the version property.

HTML forms meant as a minimal working front-end demo are available under src/web/. Given default port 8080 is usually in use, the forms send requests to port 8888 instead.

The current configuration defaults to port 8888. If you'd like to set a different port, use the -Dserver.port=<port number> command line argument:

java -Dserver.port=8871 -jar build/libs/mirante-<version>.jar

Documentation

To know more, go to the documentation website for access to the latest available documentation.

If you are looking for a formal description of the system, a document is available as part of the v0.1.1 development report. This document was adapted from the version submitted as part of a capstone project for the Applied Software Engineering course in IFSP's graduation program in Systems Analysis and Development.

This main document will only be updated on major versions. For more up-to-date information, check the development reports or access the documentation website.

Development

Mirante is developed and tested on Java 17, more specifically Eclipse Temurin JDK 17.0.10+7.

Gradle is used as a build tool to resolve dependencies and build this project. You can use the included wrapper, use Devbox (see below) or install Gradle locally.

To build and run the server:

gradle bootRun

To build only:

gradle build

To see all available options:

gradle tasks

Once the server is running, for development environments an H2 database console is available on localhost:<port>/h2-console.

The following options allow access to the H2 console:

• Driver class: org.h2.Driver
• JDBC URL: jdbc:h2:mem:mirante
• User Name: dev
• Password: Empty

If you have Devbox available on your system, you can run devbox shell to get a development environment with JDK 17 and Gradle 8 already set up. You can also use devbox run <script> to run build, test and run scripts. These scripts will all run inside the Devbox shell and come with port 8888 preconfigured.