Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/geeky-hamster/Quizmaster/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through setting up Quizmaster on your local machine. You will clone the repository, install dependencies for the backend and frontend, configure environment variables, start both servers, and log in with the default admin account.
1

Clone the repository

Clone the Quizmaster repository and navigate into the project root:
git clone https://github.com/geeky-hamster/Quizmaster.git
cd Quizmaster
2

Install backend dependencies

Navigate to the backend directory and install dependencies:
cd backend
npm install
3

Configure the backend environment

Copy the example environment file and fill in your values:
cp .env.example .env
Open .env and set your database credentials and JWT secret:
.env
DB_HOST=localhost
DB_PORT=3306
DB_NAME=quizmaster
DB_USER=root
DB_PASSWORD=your-password
JWT_SECRET=your-jwt-secret
PORT=5000
If the database does not exist yet, create it:
npm run db:create
4

Start the backend server

Start the backend in development mode:
npm run dev
The API will be available at http://localhost:5000/api.
5

Install frontend dependencies

Open a new terminal, navigate to the frontend directory, and install dependencies:
cd frontend
npm install
6

Start the frontend server

Start the React development server:
npm start
The frontend will open at http://localhost:3000 and connect to the backend at http://localhost:5000/api by default.
7

Log in as admin

Open http://localhost:3000 in your browser and log in with the default admin credentials:
  • Username: admin@quizmaster.com
  • Password: admin123

​
Default admin credentials

On first start, Quizmaster seeds a default admin account automatically:
FieldValue
Usernameadmin@quizmaster.com
Passwordadmin123
Change the default admin password immediately after your first login. Using the default credentials in any shared or production environment is a security risk.

Build docs developers (and LLMs) love

Get started for freeTalk to us