Skip to content

Commit

Permalink
Merge pull request #117 from UoaWDCC/updating-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
BW82262 authored Jan 8, 2024
2 parents f1c2ff1 + a8727ee commit f853ab3
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit f853ab3

Please sign in to comment.