This repository contains the source code for the OpenJio web application. OpenJio is a powerful and user-friendly events website tailored for university students, designed to enhance the way you discover, create, and participate in events on your campus.
-
Central Hub to Discover New Events The Central Hub feature serves as a vibrant digital marketplace where users can effortlessly explore a diverse array of events. Users can filter events based on their interests, location, or date, ensuring that they never miss out on activities that align with their preferences. With intuitive search functionalities and real-time updates, this feature keeps users informed about the latest happenings on and around their campus or community.
-
Seamless Event Registration and Personalised Queue System This feature simplifies the event participation process by offering seamless registration options. Users can easily sign up for events they're interested in, by autofilling their details. Additionally, we incorporated a personalized queue system depending on the type of event such as FCFS and Demographic-based.
-
Event Creation for University Clubs and Societies Empowering university clubs and societies, this feature provides a user-friendly platform to create and manage events. Club organizers can easily set up event details, including date, time, venue, and description. They can also specify registration requirements and capacity limits.
-
Frontend The frontend is built using React (JavaScript + TypeScript) and styled with Tailwind CSS, shadcn & MUI libraries
-
Backend: The backend is built using Spring Boot, providing a robust and efficient foundation for the application.
-
Database: The database will employ MySQL.
To set up the application locally, follow these steps:
-
Clone the repository:
git clone https://github.com/whatron/OpenJio -
Install the necessary dependencies for the frontend by running:
npm install -
Start the frontend application using:
npm start -
Start the backend application using:
mvn spring-boot:run -
Access the application in your web browser at
http://localhost:8080.
For detailed documentation on the API endpoints and usage, refer to the API documentation by accessing this url https://docs.google.com/document/d/1eeJ0TZTl-MzYSANJ1iyN6hLkrPT4yIeG_9rS9Ssncpw/edit?usp=sharing.
Done by Ashley, Ron, Pramit, Ignatius, Darius and Justin