UniHive (Project for managing club events)

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• UML Diagrams
• Mockups
• Project Report
• Authors

About The Project

UniHive is a comprehensive and efficient platform for managing club events. It facilitates the creation, promotion, and coordination of club events, making it easy for students to discover the activities offered by various clubs. It also provides students with the opportunity to join clubs at their school, thereby promoting their engagement in student life.

Built With

• Spring Boot: Java-based framework for creating standalone, production-grade Spring-based applications.
• React: A free and open-source front-end JavaScript library for building user interfaces based on components.
• Supabase: An open-source database infrastructure built on PostgreSQL.
• GitHub Actions: Utilized for continuous integration and deployment workflows. GitHub Actions automate tasks such as running tests, building and deploying your application, and more.
• Heroku: Deployment platform used to host and manage your application in the cloud. Heroku enables seamless deployment of web applications, providing scalability, reliability, and ease of management.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Java Development Kit (JDK): Ensure you have Java installed on your machine.
• Node.js: Make sure you have Node.js installed.
• npm or Yarn: Install either npm or Yarn package manager, which comes bundled with Node.js.
• Git: Ensure you have Git installed.

Installation

1. Clone the repo

   git clone https://github.com/m-elhamlaoui/development-platform-biog.git

2. Navigate to the backend directory

   cd unihive-backend

3. Install backend dependencies

   ./mvnw clean install

4. Start the backend server

   ./mvnw spring-boot:run

5. In a new terminal, navigate to the frontend directory

   cd unihive-fe

6. Install frontend dependencies

   npm install

   or

    yarn install

7. Start the frontend server

   npm run dev

   or

    yarn run dev

Now you can access the application by visiting http://localhost:5173 in your web browser.

UML Diagrams

Use case diagram

Class diagram

Mockups

Home page

Login page

Forgotten Password page

SignUp page

Events page

Events page (events drop-down)

Event page

Clubs page

Club profile page (events)

Club profile page (contact)

Club profile page (about)

Calendar page

User profile page

User profile page (settings)

Super Admin dashboard

Super Admin dashboard (admins table)

Super Admin dashboard (add)

Super Admin dashboard (edit)

Super Admin dashboard (delete)

Super Admin dashboard (clubs table)

Super Admin dashboard (events table)

Super Admin dashboard (schools table)

Super Admin dashboard (students table)

Super Admin dashboard (requests table)

Super Admin profile

Admin Dashboard

Admin Dashboard (clubs table)

Admin Dashboard (events table)

Admin Dashboard (students table)

Admin Dashboard (requests)

Admin profile

Admin Dashboard (events table)

Contact page

About page

Project Report

For detailed information about the project, including design decisions, implementation details, and future improvements, please refer to the project report. You can access the report here.

Authors

• Boutaina Moustaine - Boutaina Moustaine
• Ilyass Krichi -Ilyass Krichi
• Oumaima Nadir - Oumaima Nadir
• Ghita Loukili - Ghita Loukili