Speech Master

Node.js

Hackathon Website Template runs on Node.js Version 18.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_DATABASE_URL=
NEXT_PUBLIC_GOOGLE_CLIENT_ID=
NEXT_PUBLIC_GOOGLE_CLIENT_SECRET=

NEXTAUTH_URL=
NEXTAUTH_SECRET=

NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=
NEXT_PUBLIC_CLOUDINARY_API_KEY=
NEXT_PUBLIC_CLOUDINARY_API_SECRET=

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