seequit1/coursetable

Code powering the CourseTable website

Coursetable

Coursetable is made of two big parts:

1. Website: The site you see when you go to coursetable.com. The code for this – the front-end site as well as the various back-end scripts that handle user actions – is contained within this repository.
2. Crawler: The scripts behind the scenes that actually get all the data from Yale’s websites. The code for this is in our ferry repository.

Repository Layout

The various functions of the website are compartmentalized as follows:

• /api: Source code for Express server with Docker Compose configuration for backend logic.
• /frontend: The current face of the site, built with React.
• /sysadmin: Administration scripts and bootstrapping tools.

How to develop

Check out the getting started guide.

Contributing

Contributing code:

1. Create a branch for your feature. This can usually be done with git checkout -b <username>/<feature_name>
2. make changes.
3. Create some commits and push your changes to the origin.
4. Create a pull request and add a few reviewers. In the pull request, be sure to reference any relevant issue numbers.
5. Once the pull request has been approved, merge it into the master branch.

Style:

TypeScript & JavaScript: We use prettier to automatically format the code. Make sure you use your editor's integration!

We have automated checks set up that will run for every commit and pull request.

Roadmap:

We use GitHub issues to track bugs and feature requests: https://github.com/coursetable/coursetable/issues.

We use GitHub pull requests for active feature development: https://github.com/coursetable/coursetable/pulls.

Setting up and deploying to prod

Check out How to deploy.