Archived

This repository has been archived on 2024-09-27. You can view files and clone it, but cannot push or open issues or pull requests.

History

Owen Ryan 3331da8f22 Initial Commit		2024-09-27 11:17:53 +01:00
..
public	Initial Commit	2024-09-27 11:17:53 +01:00
src	Initial Commit	2024-09-27 11:17:53 +01:00
.env	Initial Commit	2024-09-27 11:17:53 +01:00
.gitignore	Initial Commit	2024-09-27 11:17:53 +01:00
.vale.ini	Initial Commit	2024-09-27 11:17:53 +01:00
craco.config.js	Initial Commit	2024-09-27 11:17:53 +01:00
LICENSE	Initial Commit	2024-09-27 11:17:53 +01:00
package-lock.json	Initial Commit	2024-09-27 11:17:53 +01:00
package.json	Initial Commit	2024-09-27 11:17:53 +01:00
README.md	Initial Commit	2024-09-27 11:17:53 +01:00
tsconfig.json	Initial Commit	2024-09-27 11:17:53 +01:00

README.md

BearlyPassing web app

Installing dependencies

npm install

Running

npm start

Building

npm run build

Notes for future maintainers

React

This was built using React 18. There are useMemos everywhere. React has stated that they are working on a compiler, so a significant amount of this codebase will have to be modified when it comes out.

Also, this project uses Million.js. This might not be required in the future and should probably be removed at some point.

Page Routing

BearlyPassing was designed to be a single-page application, so private school information would only be contained in the tab, and would be deleted (garbage collected) the second they closed the page. react-router had a bit too much overhead, so instead pages are controlled by the currentPage and selectedSection variables in App.tsx

Authentication and data fetching

Data fetching is extremely rudimentary, and there isn't any error handling above a generic error.

Final note

There's still some incomplete and missing stuff. Grep for TODOs and good luck!