Hackwarts 2.0

Prerequisites

• Node.js (version 18.x or later)
• npm or yarn or pnpm

Setup Instructions

1. Clone the Repository

git clone https://github.com/Google-Developer-Student-Clubs-ISSATSo/Hackwarts-2.0.git
cd Hackwarts-2.0

2. Install Dependencies

# Using npm
npm install

# Or using yarn
yarn install

# Using pnpm
pnpm install

3. Run Development Server

# Using npm
npm run dev

# Or using yarn
yarn dev

# Or using pnpm
pnpm run dev

Open http://localhost:3000 with your browser to see the result.

5. Build for Production

# Using npm
npm run build

# Or using yarn
yarn build

# Using pnpm
pnpm run build

6. Start Production Server

# Using npm
npm start

# Or using yarn
yarn start

# Using npm
pnpm start

Troubleshooting

• Clear npm/yarn/pnpm cache if you encounter dependency issues
• Verify your Node.js installation
• Check error logs for specific configuration problems/create-next-app).

Design Document

Naming convetions

• We use PascalCase for components & types + camelCase for variables and functions.
• We use kebab-case for file and folder names.

Libraries & Tools

• Next.js: React framework for production.

• TypeScript: Typed JavaScript.

• Tailwind CSS: Utility-first CSS framework.

• ESLint: Linter for code quality.

• Prettier: Code formatter.

• Zod: TypeScript-first schema declaration and validation library.

• React Hook Form: Performant, flexible and extensible forms with easy-to-use validation.

• React Query: Data fetching library for React.

• Zustand: State management for React.

• Shadcn-ui: React component library.

Database & API

• MongoDB: NoSQL database.
• Mongoose: MongoDB object modeling for Node.js.
• NextAuth.js: Authentication library for Next.js.