Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 2.34 KB

README.md

File metadata and controls

79 lines (49 loc) · 2.34 KB

House Arena

Welcome to the House Arena frontend repository! This project is designed to foster a competitive spirit within the 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.

Backend

Backend repository

Table of Contents

About the Project

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.

Features

  • 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.

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

  • Node.js (v14 or later)
  • npm (v6 or later)

Installation

  1. Clone the repository:

    git clone https://github.com/sailingsam/house_arena_react-vite.git
  2. Navigate to the project directory:

  3. Install the dependencies:

    npm install

Running the App

To start the development server, run:

npm run dev

Open http://localhost:3000 in your browser to see the application in action.

Backend Repository

The backend for this project is built using Express, Node.js, and MongoDB. You can find the backend repository here.

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes.

Contact

If you have any questions or suggestions, feel free to contact me at jainsaksham1004@gmail.com.