Quiz Builder - ❓Your ultimate quiz maker🔥

Create and manage quizzes with ease using this modern full-stack application

Live Link 🔗

Folder structure 📂

The project follows a full-stack structure:

• backend/ - Express + PostgreSQL
• frontend/ - React.js
• backend/postgres/ - Docker setup for the database
• backend/docker-compose.yml - Orchestrates services

How To Use 🔐

1️⃣ Sign Up, Install & Run Docker Desktop

Download, install and run Docker Desktop:
🔗 Docker Desktop

2️⃣ Clone the Repository

Open a terminal or command prompt and run:

git clone [email protected]:mux-mux/quiz-builder.git
cd quiz-builder

3️⃣ Setup Postgres Database

Inside the backend folder, create a file named .env with the following content:

# App Config
PORT=3001
BASE_URL=http://localhost:3001
NODE_ENV=development

# Database Config
POSTGRES_USER=postgres
POSTGRES_PASSWORD=admin
POSTGRES_DB=quiz-builder-docker
POSTGRES_HOST=postgres
POSTGRES_PORT=5432

# Connection URL
DATABASE_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}

4️⃣ Start Backend

This will set start PostgreSQL and the Express server:

cd backend
npm install
npm run docker

5️⃣ Start Frontend

This will Open the browser & listen to files changes
Open another terminal in the project root and run:

cd frontend
npm install
npm run dev

Your app should now be running!
On: 🔗 http://localhost:3000

🎯 Notes

Ensure Docker Desktop is running before executing npm run docker.
If you encounter any issues, try running:

cd backend
docker-compose down && npm run docker