MSCS Hub + MSDS Hub

The Hub is a website that allows students in UT's MSCS and MSDS to review courses and connect to student-run communities.

Computer Science - MSCSHub.com Data Science - MSDSHub.com

Each website is tailored to the indivual program but is all run using the same frontend and backend codebase. The entire frontend is built using Angular v11. The backend is serverless and runs off of firebase with node.js functions.

Prerequisites

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

You have installed the latest version of Node.js
You have web browser with JavaScript enabled. This project has been tested on Windows, Mac, and Linux.
You are familiar with general web development techniques and technologies.

Installing MSCS Hub

To install MSCSHub, follow these steps:

git clone https://github.com/MSCSHub/MSCSHub.git
cd MSCSHub
npm install
ng serve

Note: The npm install step will install all of the required dependencies, including Angular ng. If ng serve does not work at first you may need to try performing a global install.

Using MSCS Hub

Local Development

After running ng serve you will have a local version of MSCSHub.com running on your machine. Open your favorite browser and navigate to localhost:4200 to begin

Please note that the backend data is shared regardless if you are running locally or in production. You will need a MSCS Hub account.

Deploying to MSCSHub.com and MSDSHub.com

Use the command npm run deploy to run the deployment script that will update both MSCSHub.com and MSDSHub.com. If you want to see more about what's happening behind the scenes when you run this command, take a look at the scripts section of package.json.

Documentation

The documentation for MSCSHub.com is hosted at https://mscshub.github.io/MSCSHub-documentation/. This is generated automatically using compodoc. It works by automatically parsing the files in the codebase and uses the inline comments to create a fully functional website for documentation.

Contributing to The Hub

To contribute to MSCSHub, follow these steps:

Create an issue on the repo https://github.com/MSCSHub/MSCSHub/issues
Assign yourself (or someone else) to the new issue.
Branch Bot will automatically create a new branch
On your local machine, first git pull then switch to the new branch: git checkout -b <branch_name>.
Make your changes and commit them: git commit -m '<commit_message>'
Push your changes to the MSCSHub repo: git push
Create the pull request.
Get signoff from the required reviewers and merge the changes
The repo owner (@EricPryzant or @estraw1059) will deploy the changes once the PR is merged

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the following people who have contributed to this project:

@EricPryzant 💻
@estraw1059 🔧
All of the #koolkidz that helped beta test this 🐛
All of the students that have created reviews 👀
Everyone who has donated to this project to keep it running! 💸

Contact

If you want to contact the owners of this repo you can reach us at mscshub@gmail.com.

License

This project uses the following license: AGPLv3.

MSCSHub / MSCSHub