cheatcodesam / rosehack2024

RoseHack 2024 Website

Figma

RoseHack 2024 Website Figma Design File

Node.js

Hackathon Website Template runs on Node.js Version 16.17.0 and higher. Please ensure you have Node.js installed via the official website.

Next.js

This project is built using Next.js, a React framework. Next.js is automatically installed when you install all dependencies for this project.

Environment Variables

The following environment variables are required and must be stored in an .env file:

NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=
NEXT_PUBLIC_FIREBASE_CLIENT_EMAIL=
NEXT_PUBLIC_FIREBASE_PRIVATE_KEY=
NEXT_PUBLIC_GOOGLE_CLIENT_ID=
NEXT_PUBLIC_GOOGLE_CLIENT_SECRET=
NEXTAUTH_SECRET=
NEXTAUTH_URL=
NEXT_PUBLIC_GOOGLE_CALENDAR_API_KEY=
NEXT_PUBLIC_GOOGLE_CALENDAR_EMAIL=

Commands

Dependencies

# Install dependencies
npm i

# Add dependency
npm i <dependency>

# Remove dependency
npm un <dependency>

Running the Website Locally

# Open a browser at localhost:3000
npm run dev

Formatting Code via Prettier

# Rewrite code recursively with proper formatting
npm run format

# Show formatting differences recursively
npm run check

Linting Code via Eslint

npm run eslint

Build the Website

npm run build