Insieme Dashboard

Leaderboard, dashboard for Ridge View Residential College's Freshmen Orientation Programme 2024: Insieme.
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Database Management
2. Getting Started
   • Prerequisites
   • Installation
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This product serves as a dynamic leaderboard and dashboard for Insieme, the inaugural Freshmen Orientation Programme for Ridge View Residential College in the National University of Singapore. It is designed to enhance the engagement and competitive spirit among participants. This platform is built with the aim of fostering a sense of community and teamwork, while also streamlining the administrative tasks associated with managing the orientation programme.

Key Features:

• Dynamic Leaderboard: Instantly updates to reflect current standings, making the competition more exciting and engaging for participants.
• Role-Based Access Control (RBAC): Implements a comprehensive RBAC system to ensure users only access features and information relevant to their roles. This system enhances security and operational efficiency by categorizing users into roles such as participants, game masters, and administrators, each with tailored access and capabilities.
• Activity and Points Log: Allows game masters to easily add new activities and update points, ensuring a smooth operation of the event.
• Deduction Feature: Enables adversarial orientation groups to apply deductions to other groups, adding a strategic element to the competition.
• User-Friendly Interface: Designed with the user in mind, the interface is intuitive, making navigation and usage straightforward for all participants.

Why?

• Custom-Built for RVFOP 2024: Tailored specifically for the needs of Ridge View Residential College's Freshmen Orientation Programme, ensuring a perfect fit for the event's requirements.
• Enhances Participation: By providing a real-time leaderboard, Insieme keeps the competitive spirit alive and keeps participants engaged throughout the programme.
• Streamlines Administration: Reduces the workload on organisers by automating the tracking of scores and activities.

By integrating technology with tradition, we're setting a new standard for how orientation programmes are conducted.

(back to top)

Built With

• React
• Vite
• Supabase (DB and User Authentication)
• Vercel (Website Hosting)
• React95 (UI Library)
• Resend (SMTP Server)

(back to top)

Database Management

The project uses PostgreSQL, provided by Supabase, for database management.

(back to top)

Getting Started

To set up the project locally, follow these simple steps.

Prerequisites

• A Supabase account for database and authentication services.
• npm

  npm install npm@latest -g

Installation

1. Clone the repo and install dependencies.

   git clone https://github.com/nicholasohjj/rvfop-dashboard.git
    cd rvfop-dashboard
    npm install

2. Configure your .env.local with Supabase credentials

   VITE_SUPABASE_URL = "YOUR SUPABASE URL"
   VITE_SUPABASE_ANON_KEY = "YOUR ANON KEY"

3. Start the project

   npm run dev;

Testing

Includes E2E Testing with Cypress.

1. Adjust cypress.config.js to match your local setup.

2. Create cypress.env.json for authentication during tests:

   {
    "CORRECT_USER_EMAIL": "YOUR USER EMAIL",
    "CORRECT_USER_PASSWORD": "YOUR PASSWORD"
    }

3. Run tests with Cypress:

   npm run dev
   npx cypress run;

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nicholas Oh - @nicholasohjj - nicholasohjj@gmail.com

Project Link: https://github.com/nicholasohjj/rvfop-dashboard

(back to top)