https://github.com/proximobinks/university-clubs-website
An interactive platform to manage and join University Clubs. Features admin controls, club creation, and user-friendly interface for enhanced campus engagement.
https://github.com/proximobinks/university-clubs-website
Last synced: about 1 year ago
JSON representation
An interactive platform to manage and join University Clubs. Features admin controls, club creation, and user-friendly interface for enhanced campus engagement.
- Host: GitHub
- URL: https://github.com/proximobinks/university-clubs-website
- Owner: ProximoBinks
- License: mit
- Created: 2023-10-04T14:09:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T04:18:38.000Z (over 1 year ago)
- Last Synced: 2025-04-12T01:16:41.555Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 3.17 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Collaborators
This project was made as a collaborative effort between Elliot Koh, William Gambling and Kei as a part of our studies at the University of Adelaide
# How to Set Up Your University Club's Website
[](https://github.com/ProximoBinks/University-Clubs-Website/blob/main/LICENSE)
## Setup Instructions
Follow these steps to set up and launch your website:
1. **Download and Launch Docker**
- [Download Docker](https://www.docker.com/products/docker-desktop/) from its official website and run the application.
2. **Open Project Folder in VSCode**
- Open the folder containing the project files in Visual Studio Code. You can either clone this GitHub repo or dowwload it as a zip file.
3. **Build Dev Container**
- Press `F1` and execute the command `Dev Containers: Rebuild and Reopen in Container`.
4. **Start MySQL Daemon**
- Open a terminal within VSCode and run the command `mysqld start`.
5. **Initialize MySQL Daemon**
- In the same terminal, enter the command `mysqld`.
6. **Open New Terminal**
- Click to open a new terminal within VSCode.
7. **Import Database Backup**
- Run the command `mysql < db/DatabaseBackup.sql` to import the database backup.
8. **Start Application**
- Run the command `npm start` to launch the web application.
9. **Visit Localhost**
- Open your web browser and go to `http://localhost:8080/`.
10. **Final Steps**
- Congratulations! You have successfully set up the University Club's website.
## Additional Information
- **Administrator Access (Test Admin Account)**
- Logging in with `test@test.com` and the password `test` grants you admin privileges. Access the admin dashboard at `http://localhost:8080/admin.html` to manage users, permissions, and more. To add more admins, you can either use SQL commands or the GUI on the admin page.
- **Creating and Managing Clubs**
- Clubs can only be created by logged-in users through a button at the top of the webpage. Club creators become managers by default. Initially, the database contains no clubs, allowing you to test the system by creating or deleting as many clubs as you wish.
## License
This project is licensed under the MIT License.
