1
1
Fork 0
mirror of https://github.com/CoffeeClasses/CoffeeClasses-Spring.git synced 2026-04-17 01:18:16 +02:00
CoffeeClasses is a web application designed for academic management, catering to the needs of students, teachers, and administrators.
  • Java 76.3%
  • CSS 23.7%
Find a file
2024-12-02 23:07:47 +01:00
.github/workflows feat: Base project 2024-11-26 14:03:57 +01:00
.mvn/wrapper feat: Base project 2024-11-26 14:03:57 +01:00
src/main chore: Correct home-content.jsp 2024-12-02 18:41:43 +01:00
.gitignore feat: Base project 2024-11-26 14:03:57 +01:00
mvnw feat: Base project 2024-11-26 14:03:57 +01:00
mvnw.cmd feat: Base project 2024-11-26 14:03:57 +01:00
pom.xml feat: Add Mail Service 2024-12-01 13:07:32 +01:00
Rapport Projet JEE CoffeeClasses.pdf Add project report 2024-12-02 23:04:07 +01:00
README.md fix: Fix minor inconsistency in note 2024-12-02 23:07:47 +01:00

CoffeeClasses (Spring)

CoffeeClasses is a web application designed for academic management, catering to the needs of students, teachers, and administrators. The application supports essential functionalities such as managing students, courses, enrollments, and grades while ensuring secure role-based access.

Built with Spring Boot, this version of CoffeeClasses implements a robust MVC architecture, utilizing Hibernate for ORM and JSP for user interfaces. It offers a more streamlined development and deployment experience compared to the Jakarta EE (Vanilla) version.

CoffeeClasses requires Java 21 or later.

Click here for the Jakarta EE version of CoffeeClasses.

How to build

Instructions

First, clone the project with git :

git clone https://github.com/CoffeeClasses/CoffeeClasses-Spring

Then simply run this command, which uses the bundled maven wrapper (or you can use your existing mvn installation instead) :

Warning

mvnw.cmd currently has a Windows-specific issue making it unusable with users that have spaces in their username. This includes the default account on CY Tech computers "CYTech Student".

Your options are :

  • Use a different account without spaces in the username.
  • Use a proper mvn installation (installed with Chocolatey for example).
  • Use a Linux-based system (like Ubuntu or even WSL).

Note

In some situations, it may be necessary to run mvn clean to avoid dependency issues before running the package command.

Linux Windows
./mvnw package mvnw.cmd package

This command will package the application into a .war file, which you can easily run at any time through a Tomcat server.

How to run

(Note : running the application also requires Java 21 or later. The application has been successfully tested on GraalVM and OpenJDK.)

Database setup

CoffeeClasses uses a PostgreSQL database, only supporting localhost + default port configurations. You can set up the necessary database with the following SQL commands :

CREATE USER coffeeclasses WITH PASSWORD 'coffeeclasses';
DROP DATABASE IF EXISTS coffeeclassesdb;
CREATE DATABASE coffeeclassesdb OWNER coffeeclasses;

Running the application

You can either deploy the built .war file to a Tomcat server or run the application directly with the following command :

Note

In some situations, it may be necessary to run mvn clean to avoid dependency issues before running the spring-boot:run command.

Linux Windows
./mvnw spring-boot:run mvnw.cmd spring-boot:run

Note : Default admin user is admin-coffeeclasses@yopmail.com with password admin123.