Welcome to the House Arena frontend repository!
I made this project as part of Buildspace N&W's5 Project as well as my MERN course project.
This project is designed to foster a competitive spirit within the SST student community by allowing you to track house points, view past events, and celebrate achievements. This repository contains the frontend code for the House Arena application built using React and Vite.
for backend please use this link as reference: Backend repository
Hi! I am Saksham Jain, I made this project as part of my buildspace N&Ws5 program.
House Arena is your one-stop platform for tracking house points, viewing past events, and fostering a vibrant spirit of competition and camaraderie among your individual houses. Each house in the student community can view their progress, participate in events, and aim for the top of the leaderboard.
- Track the current leaderboard of house points
- View detailed scores of past events
- User authentication with login and registration pages
- For Admins: can add/update/delete events info.
Ensure you have the following installed on your local machine:
- Node.js (v14 or later)
- npm (v6 or later)
-
Clone the repository:
git clone https://github.com/sailingsam/House-Arena_frontend.git
-
Navigate to the project directory:
-
Install the dependencies:
npm install
To start the development server, run:
npm run devOpen http://localhost:3000 in your browser to see the application in action.
The backend for this project is built using Express, Node.js, and MongoDB. You can find the backend repository here.
All code contributions must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.
We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.
If you have any questions or suggestions, feel free to contact me at [email protected].
