reeceyang / hydrant

Hydrant

Setup

Install:

• Python 3, at least Python 3.6.
• Node.js 16, at least Node 16.16.
  • Careful, the latest version is 18!
  • One way manage Node versions is using nvm.

In the root directory, run:

• pip install -r requirements.txt to install dependencies.
• npm install to install dependencies.

Updating

Local development

There's the frontend, which is the website and the interface. Then there's the backend, or the schedules, which are the files that have information about class schedules.

To update the frontend, you can run npm start, which will open a browser tab that updates live as you edit code.

To update the backend, cd scrapers then run python update.py.

Make sure to update the backend before you run the frontend for the first time.

Changing semesters

Let's say you're updating from e.g. Spring 2023 to Fall 2023.

First, archive the old semester. Make sure you have updated schedule files. Then run mv public/latest.json public/s23.json.

Then, update the new semester. Open public/latestTerm.json, change urlName to f23, and update the dates per Registrar.

Finally, run the normal update process and commit the results to the repo.

Updating the server

The server's frontend updates based on the deploy branch on GitHub, so any changes pushed there will become live.

The server's backend is updated through a cron script that runs update.py every hour.

See deploy/README.md for more info.

Development notes

Architecture

I want to change...

• ...the data available to Hydrant.
  • The entry point is scrapers/update.py.
  • This goes through src/components/App.tsx, which looks for the data.
  • The exit point is through the constructor of State in src/lib/state.ts.
• ...the way Hydrant behaves.
  • The entry point is src/lib/state.ts.
  • The exit point is through src/components/App.tsx, which constructs hydrant and passes it down.
• ...the way Hydrant looks.
  • The entry point is src/components/App.tsx.
  • We use Chakra UI as our component library. Avoid writing CSS.

Technologies

Try to introduce as few technologies as possible to keep this mostly future-proof. If you introduce something, make sure it'll last a few years. Usually one of these is a sign it'll last:

• some MIT class teaches how to use it
  • e.g. web.lab teaches React, 6.102 teaches Typescript
• it's tiny and used in only a small part of the app
  • e.g. msgpack-lite is only used for URL encoding, nanoid is only used to make IDs
• it's a big, popular, well-documented project that's been around for several years
  • e.g. FullCalendar has been around since 2010, Chakra UI has a large community