Merge branch 'main' of https://github.com/uoawdcc/uasc-web

UoaWDCC · Mar 11, 2024 · f931780 · f931780
2 parents b2c2204 + d9aee45
commit f931780
Show file tree

Hide file tree

Showing 31 changed files with 685 additions and 320 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,5 +1,9 @@
-name: Run tests on PR
-"on": pull_request
+name: Run all tests
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 jobs:
   Run-Tests:
     runs-on: ubuntu-latest

diff --git a/.prettierignore b/.prettierignore
@@ -1 +1,2 @@
-**/__generated__
+**/__generated__
+**/*.index.html
diff --git a/README.md b/README.md
@@ -2,12 +2,19 @@
 
 Project initiated by WDCC in 2023.
 
-## Team Leadership
+## 2024 Team Leadership
+
+- Benson Cho (Tech Lead)
+- Eddie Wang (Project Manager)
+
+## 2024 Team Members
+
+## 2023 Team Leadership
 
 - Bill Wong (Project Manager)
 - Tony Feng (Tech Lead)
 
-## Team Members
+## 2023 Team Members
 
 - Atharva Arankalle
 - Campbell Wood
@@ -24,74 +31,6 @@ with the purpose of improving bookings for both users and admins.
 
 **2024:** We are focused on providing a functional membership management system for UASC
 
-Tech Stack:
-
-- React
-- Express
-- Firebase
-- Stripe
-- tsoa
-
-Material UI is used as the styling library.
-
-## Getting Started
-
-To begin, run `yarn` at the root (the directory this `README.md` is in). This will install all the dependencies used for this project.
-
-If you are using VS Code run `yarn vsc-setup` which will install ESLint and Prettier. Other environments like nvim please refer to relevant documentation to set this up. Setting up auto formatting is recommended (for VSC: `File > Preferences > Settings > Text Editor > Formatting`)
-
-We are using **yarn workspaces** so if you want to (run all these commands from the root if possible):
-
-**Add any packages:**
-
-- To add to the client (frontend) run `yarn workspace client add <package-name> <--dev>(if dev dependency)`
-- To add to the server (backend) run `yarn workspace server add <package-name> <--dev>(if dev dependency)`
-
-**Run the dev environment:**
-
-- Start client (frontend) run `yarn dev-client`
-- Start server (backend) run `yarn dev-server`
-
-## Pre commit hooks
-
-We use `husky` to run linters and formatters on each commit to help ensure that code quality is maintained before pushes. These will be done automatically, however if your device is ~~trash~~ slow then it is acceptable to add `--no-verify` to the end of your `git commit`. However if you are going to push the commit(s) avoid doing this and allow the precommits to run before you push.
-
-## Code generation
-
-We make use of `openapi-typescript` to create types for the frontend (based on `swagger.json`) when calling our backend API and `tsoa` to automatically generate routes for our express application and create a `swagger.json`.
-
-- To generate types for the frontend run `yarn workspace client generate-types`
-- To generate routes for the backend run `yarn workspace server tsoa spec-and-routes`
-
-**Note:** this is automatically handled when running the dev commands
-
-## Testing
-
-Testing is handled with jest and tests should be written where possible
-
-- To test everything, run `yarn test`. Otherwise find the relative path of the file to test use `npx jest <file-name>`.
-
-- To test everyting in backend run `yarn workspace server test` (IMPORTANT if you do not have firebase emulator running!)
-
-- To test everyting in frontend run `yarn test-client` (TODO: fix naming haha)
-
-## Emulators
-
-Don't play around with the prod DB during development. Make sure you have firebase cli installed globally with `npm install -g firebase-tools` and run `firebase emulators:start`. Both the server and client should be running using the same config. This is also important when writing integration tests for the backend.
-
-## ENV File format
-
-**Client**:
-
-```
-VITE_FIREBASE_API_KEY=
-VITE_ENV=
-VITE_BACKEND_BASE_URL=
-```
-
-**Server**:
+## Get started
 
-```
-DEV=
-GOOGLE_APPLICATION_CREDENTIALS = .firebase/service-account.json
-```
+[Check out the wiki page on onboarding](https://github.com/UoaWDCC/uasc-web/wiki/Onboarding)
diff --git a/client/index.html b/client/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />

diff --git a/client/src/models/__generated__/schema.d.ts b/client/src/models/__generated__/schema.d.ts