From a8727eed77066dc7b0c1aefab80bc4f1f85433d9 Mon Sep 17 00:00:00 2001 From: bwon783 <86991521+BW82262@users.noreply.github.com> Date: Mon, 8 Jan 2024 19:56:11 +1300 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index a4239cc0a..cc136fa73 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,32 @@ # UOA Snowsports Club Website & Booking System + Project initiated by WDCC in 2023. ## Team Leadership - Bill Wong (Project Manager) - Tony Feng (Tech Lead) + +## Team Members + +- Atharva Arankalle +- Campbell Wood +- Edward Li +- Mitchell Wong +- Selin Akkaya +- Tony Yin +- Zaid Mustafa + +## About + +This project is focused on developing a new website for the University of Auckand's Snowsports Club (UASC) from their existing website, +with the purpose of improving bookings for both users and admins. + +The technology used is ReactJS for the frontend and Firebase as the database. +Material UI is used as the styling library. + +## Getting Started + +To begin, navigate to the frontend directory, and excute the command: `npm install`. This will install all the dependencies used for this project. +After all the dependencies have finished downloading, to run the project, run command: `npm start`. +To start Firebase, in a seperate terminal, run: `npm run start:firebase`