/hyperplanner

Web App for planning/reviewing all 4 years of college!

Primary LanguageTypeScriptMIT LicenseMIT

HyperPlanner

The Web App for planning/reviewing all 4 years of college!

Banner

Check it out here!


HitCount Dependencies DevDependencies

List of currently-supported schools:

  • Harvey Mudd College

How was this developed?

  • TypeScript and React used for Frontend

  • AWS (S3, SQS, SNS, Textract, Lambda, API Gateway) and Python used for transcript text recognition (repo)

  • AWS (Lambda, API Gateway, AppSyn) and Golang used for querying courses (repo) - experimental

  • Netlify used for deployment of the web app

  • Travis CI used for CI/CD tests

  • Jest/React Testing Library used for unit tests

  • Prettier and ESLint (Airbnb preferences) used for best coding practices

  • Auth0 used for user authentication/authorization

  • Google Analytics used to track site statistics

Where is the Backend?

The Backend of HyperPlanner uses Hasura, which is an open source engine connecting our PostgreSQL Database to our GraphQL Backend. This is hosted on Heroku, located here. The Frontend communicates with the GraphQL engine using Apollo Client.

What is the development workflow?

First clone the repository onto your local machine. You can then run the following commands:

npm install

Install all of the depedencies.

npm run start

Runs the app in the development mode with live updates.
Open http://localhost:3000 to view it in the browser.

npm run format:fix

Formats the files with Prettier.

npm run lint:fix

Lints the files with ESLint.

npm run test

Runs the test suite. Make sure that all tests pass before committing/pushing!