Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.
/ gradelog Public archive

A JSF-based web app that provides all the functionality needed to organize and plan a school operation

License

Notifications You must be signed in to change notification settings

runekrauss/gradelog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gradelog

Gradelog is a JSF-based web app that provides all features needed to organize and plan a school operation.

Website

🎯 Features

  • Calendar with reminders
  • Dynamic dashboard
  • Messaging system
  • Plans like a substitution schedule with CSV imports
  • Users and groups
  • And much more

🚀 Getting Started

🔧 Installation

Open your terminal and go to the root directory of this cloned repository. Afterwards, type the command mvn package. Then the WAR file is located in the created directory target.

The next step is about installing GlassFish, which must be downloaded and unzipped. Now go into the bin directory.

Windows

Run asadmin.bat and type start-domain as well as start-database.

Linux and macOS

Type the following commands:

$ ./asadmin start-domain
$ ./asadmin start-database

If you want to stop the server, just type:

$ ./asadmin stop-domain
$ ./asadmin stop-database

The server is now available at http://localhost:4848.

To install Gradelog, the following final steps are necessary:

  1. Click Applications on the left sidebar.
  2. Click Deploy.
  3. Click Choose File at Packaged File to Be Uploaded to the server.
  4. Select the WAR file.
  5. Look for Context Root where you can edit the root, i.e. if you change it to gradelog, the homepage will be available at http://localhost:8080/gradelog.
  6. Confirm with Ok.

💻 Usage

If the app is successfully installed, the following login page should be accessible:

Login Page

By default, the first login is via the username admin and password Test123#. The Gradelog interface will then be shown.

👀 Examples

🔶 Changing Language

Profile

To change the language, first go to Profil. Scroll down to the Sprache label. Now use the drop-down menu to set a desired language such as Englisch.

🔶 Changing Password

To change the password, scroll to the Password label. Now enter the new password and confirm it by clicking the button labeled Save.

✅ Tests

To run the unit tests, the command mvn package is sufficient.

The test coverage can be viewed using cobertura:cobertura && mvn site.

📖 Documentation

The Gradelog documentation becomes available by typing mvn javadoc:javadoc in the terminal.

⚠️ License

Gradelog is licensed under the terms of the MIT license.

🏆 Award

Gradelog was honored as the Best Project of the student course Software-Projekt 2 at University of Bremen in 2017. It was developed according to Oberschule Ronzelenstrasse requirements.

About

A JSF-based web app that provides all the functionality needed to organize and plan a school operation

Topics

Resources

License

Stars

Watchers

Forks