Welcome to our senior project repository! This project aims to create a website using GitHub Pages, HTML, auth0 and JavaScript to facilitate real-time updates from teachers that will be displayed on a bulletin board in the MSU Denver Aerospace and Engineering Sciences 2nd floor hallway. We are using Anthias to display our website on the bulletin board.
Project repository: https://github.com/orgs/MSU-Denver-Bulletin-Board/repositories
Project entrypoint SPA: https://dhelms33.github.io/msudenver-bulletin-board.github.io/
Project nodejs hosted on firebase(beta): https://github.com/MSU-Denver-Bulletin-Board/nodejsBB-beta
Project entrypoint Merged: https://bycarlosfp.github.io/MSUDBBDemo/
- Real-Time Updates: Utilizing JavaScript and Firebase, the platform allows teachers to post real-time updates that students can instantly view.
- File Uploads: Teachers can upload and share files, documents, and other resources with their classes, enhancing the learning experience.
- GitHub Pages: Hosts the static website, making it accessible to users without the need for a dedicated server.
- HTML: Provides the structure and layout of the website.
- JavaScript: Enables dynamic and interactive features on the client side.
- Firebase: Powers real-time updates and file uploads, ensuring a seamless and secure experience.
The project follows a modular structure, with separate files for HTML, JavaScript, and potentially CSS. Key directories include:
docs
: GitHub Pages source files.src
: Source code for HTML, JavaScript, and CSS.assets
: Store images, logos, or other media files.js
: Contains JavaScript files for different functionalities.styles
: Houses CSS stylesheets.
Follow these steps to get the project running on your local machine:
-
Clone the repository:
git clone https://github.com/your-username/senior-project.git a) Open the docs/index.html file in your web browser. b) Start exploring and testing the real-time updates and file uploads features.
We welcome contributions to enhance and improve our platform. If you have ideas, bug fixes, or new features to propose, please follow our contribution guidelines outlined in CONTRIBUTING.md.
This project is licensed under the MIT License, which means you are free to use, modify, and distribute the code as long as you include the original copyright and license notice.
We would like to express our gratitude to everyone who contributed to the project and supported us throughout our senior project journey.
Thank you for exploring our real-time classroom updates platform! Feel free to reach out if you have any questions or feedback.