Skip to main content

​
Quickstart Guide

Get the NJ Rajat Mahotsav event platform up and running on your local machine in just a few minutes.

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js 18+ and npm
  • Git for cloning the repository
  • A code editor (VS Code recommended)

​
Quick Setup

1

Clone the repository

Clone the project from GitHub:
git clone https://github.com/vijaykpatel/Rajat-Mahotsav-Website.git
cd Rajat-Mahotsav-Website
2

Install dependencies

Install all required packages:
npm install
3

Set up environment variables

Create a .env.local file in the project root with the following variables:
.env.local
# Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=your_supabase_project_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key

# Cloudflare R2 (Optional for local dev)
R2_ENDPOINT=your_r2_endpoint
R2_ACCESS_KEY_ID=your_access_key
R2_SECRET_ACCESS_KEY=your_secret_key
R2_BUCKET_NAME=your_bucket_name
R2_BUCKET_PREFIX=your_prefix
For local development, you only need the Supabase variables. Cloudflare R2 is optional unless you’re testing file uploads.
4

Run the development server

Start the Next.js development server:
npm run dev
The application will be available at http://localhost:3000.
5

Verify the setup

Open your browser and navigate to http://localhost:3000. You should see the NJ Rajat Mahotsav landing page.
The site will work without Supabase for browsing, but you’ll need it configured for registration and admin features.

​
What’s Next?

Full Installation Guide

Complete environment setup with Supabase and Cloudflare configuration

Architecture Overview

Learn about the platform’s architecture and design patterns

Core Features

Explore event registration, admin dashboard, and more

Component Library

Browse the atomic design component structure

​
Common Commands

# Run development server
npm run dev

# Build for production
npm run build

# Start production server
npm start

# Run linter
npm run lint

​
Troubleshooting

If port 3000 is already in use, you can specify a different port:
PORT=3001 npm run dev
Clear your node_modules and reinstall:
rm -rf node_modules package-lock.json
npm install
Make sure your .env.local file is in the project root directory (not inside app/ or src/). Restart the dev server after creating or modifying the file.

​
Next Steps

Now that you have the platform running locally, explore these resources:

Build docs developers (and LLMs) love

Get started for freeTalk to us