Club Hub is a web-based university club management service designed to enhance experiences among members of various clubs. The application aims to provide a platform for planning club events, managing memberships, facilitating discussions through forums, and fostering community engagement.
- User authentication and authorization: Users can sign up, log in, and log out
- Create club: Each user can create a single club
- Search for clubs: Search for clubs and join based on keywords
- Threads discussion: Each club can create threads and nested-reply to threads
- Make announcements: Each club can create social posts as announcements
- Manage events: Each club can create events and members can register/unregister for events
- Chatting: Each club can create chatrooms and send messages to club members. Chatrooms are live and can be accessed by any club members.
- Node.js (v12.0.0 or higher)
Download: https://nodejs.org/en/download/package-manager
- npm (v10.1.0)
npm install npm@latest -g
-
Option 1 (preferred): MySQL server running on your local system and any preferred GUI (e.g. MySQL Workbench)
-
.env file with the following variables:
- DB_HOST (e.g. localhost)
- DB_USER (e.g. root)
- DB_PASSWORD (e.g. password)
- DB_NAME (e.g. clubhub)
- You can run the code in clubhub_create_db.sql file to create the database and tables on your local system
-
-
Option 2 (optional): We also host our database server online, in which case you can use the following variables (we used freemysqlhosting.net):
- DB_HOST= sql3.freemysqlhosting.net
- DB_USER= sql3749296
- DB_PASSWORD= ZXRZuYlU94
- DB_NAME= sql3749296
To get started with Club Hub, follow these steps:
-
Clone the repository
git clone https://github.com/Daoranger/Club-Hub.git -
cd into Club-Hub directory
cd Club-Hub -
Launch your local MySQL server (preferred MySQL Workbench). Copy-paste and execute the code in clubhub_create_db.sql file (path: Club-Hub/backend/mysql/clubhub_create_db.sql) to create the database and tables on your local system.
-
To run Club Hub on your local system, open two terminals and run the following commands:
On the first terminal, navigate to the backend directory and run the following command:
cd backendOnce you are in the backend directory, create a .env file with the variables in prerequisites section (we prefer the variables in Option 1). Then run the following command:
npm install npm startYour backend should be running now. you should get two message that said
"Connected to backend!" "DB Connection is good!"On the second terminal, navigate to the client directory and run the following command:
cd client npm install npm startAfter running the command, your browser should automatically open the Club Hub application. You should see home page of Club Hub. If not, open your browser and navigate to http://localhost:3000.
If it is your first time running the application, you will need to sign up for an account. Then log in with your account credentials.
Once you login, explore and have fun!
-
Hoang Nguyen:
-
Non-technical:
- Pitched the idea of Club Management Web App
- Contributed to project proposal
- Organized meetings
- Determined tech stack
- Contributed and reviewed EER diagram
- Contributed to presentation slides
- Contributed to relational model documentation
- Kept track of meeting minutes
- Contributed to part of final report
- Wrote the README.md file
- Created Club Hub Logo
-
Code:
- Set up the Github repository and initial project structure with Nathan Durrant
- Set up the initial backend server and frontend structure
- Implemented threads page, create thread, and reply to thread functionalities
- Implemented post page and contributed to part of post comment functionality
- Implemented events page, created event, and registered for event functionalities
- Contributed to part of search club functionality
- Fixed bugs for signup, post's comments, and dashboard functionalities
- Fixed other minor bugs
-
-
Nathan Durrant:
-
Non-technical:
- Organized meetings
- Determined tech stack
- Contributed to project proposal
- Contributed to and reviewed EER diagram
- Contributed to final presentation slides
- Normalized relational tables to BCNF
- Finalized relational model documentation
- Contributed to part of final report
-
Code:
- Assisted Hoang in setting up file structure after intial setup
- Implemented login page and login functionality
- Connected club display in dashboard to the backend
- Implemented indexing in our create table statements to improve performance
- Updated implementation of role checking to check if the user is specifically the owner of the club
-
-
Shervan Shahparnia:
-
Non-technical:
- Pitched the idea for the name of our web app "Club Hub"
- Contributed to project proposal
- Contributed to and reviewed EER diagram (Finalized EER diagram and reorganized for readability)
- Contributed to presentation slides
- Contributed to relational model documentation discussion
- Kept track of meeting minutes
- Contributed to part of final report
-
Code:
- Implemented initial dashboard page with club creation, application navigation bar, & dark mode functionality
- Implemented Club member list and @mention functionality within Chat Room
- Assisted Nathan Cohn in implementing and discussing design decisions for navigation systems
- Contributed to various styling factors for client
-
-
Aaron Sam:
-
Non-technical:
- Contributed to project proposal
- Contributed to presentation slides
- Contributed to relational model documentation discussion
- Kept track of meeting minutes
- Contributed to part of final report
-
Code:
- Implemented intial search page for the list of clubs and the comment feature for the post page
- Contributed to the backend database functionality
- Contributed to various styling factors for client
-
-
Nathan Cohn:
-
Non-technical:
- Helped with the project proposal.
- Contributed to and reviewed the EER diagram.
- Worked on mapping the EER diagram to relational tables.
- Helped normalize relational tables to BCNF.
- Introduced the idea for chatroom and comments.
- Removed redundancies in the EER diagram.
- Assisted with the final report.
-
Code:
- Implemented and fixed dark mode for most webpages.
- Implemented a User context to track logged-in users and save them to local storage.
- Created the sign-up page and its respective backend query.
- Implemented Private Routes to ensure the user is logged in.
- Developed the ChatRoom page and messaging system with related backend queries.
- Built the Side Bar for navigation throughout club pages with related backend queries.
- Added checks to ensure users can create only one club, along with the necessary queries.
- Fixed and reorganized navigation to be more user-friendly and useful for frontend code.
- Created database files such as
create,insert, anddropscripts. - Debugged database files to ensure consistent and valid database access.
- Adjusted and debugged CSS on some pages to ensure correct frontend implementation.
-
- Project Proposal
- Project EER Diagram
- Project Meeting Minutes
- Project Presentation
- Project Final Report
