IntelleQuiz

Speed up your quiz journey with IntelleQuiz - knowledge in a flash.

🔋  Features

• Organized File and Folder Structure

• Well-organized & intuitive UI

• Server Side State Management & using React.

• Client Side States Management with Recoil

• Custom Hooks

• Schema Validation using zod.

• Robus Authentication

• Google SSO (Single Sign-On)

• Security Measures like rate limiting and referesh tokens.

• Dark and Light Mode

⚙️  Tech Stack

• Postgresql – database

• Express – framework

• React – frontend

• Node.js – JavaScript runtime

• Tailwind CSS – CSS

• Recoil – state management

• Prisma – ORM

• Git – versioning

• Docker – containerziation

• Vite – building

• Vercel – frontend deployment

• AWS - backend dockerize websocket deployment

• DOCKERHUB - deploying images

🐳   Quick Start with Docker

0. Prerequisites

   Make sure you have the Docker installed on your machine.

1. Clone the repository:

   git clone https://github.com/imkurosaki/IntelleQuiz.git   

2. Navigate to the project directory:

   cd intellequiz 

3. Add Environment Variables:

   Create .env files in the server and client folder and copy paste the content of .env.sample

   # server side
   cd server
   cp .env.sample .env # then update `.env` with your creadentials.
   cd ..
   
   # client side
   cd client
   cp .env.sample .env # then update `.env` if required.
   cd ..

4. Start all services using Docker Compose:

   docker-compose up --watch
   
   # --watch to Enable Watch (For Live Update aka Hot Reloading)

🖥️   Manual Setup

0. Prerequisites
   Make sure you have the following installed on your machine:

   • Git
   • Node.js
   • npm (Node Package Manager)

1. Clone the repository:

   git clone https://github.com/imkurosaki/IntelleQuiz.git   

2. Navigate to the project directory:

   cd intellequiz 

3. Setup Backend:

   • Navigate to the Backend Codebase:

     cd backend/

   • Install dependencies:

     npm install

   • Add Environment Variables:

     Create .env file in the root folder and copy paste the content of .env.sample

     cp .env.sample .env

     Update credentials in .env with your creadentials.

   • Start the Server:

     npm run dev 

4. Setup Frontend:

   • Navigate to the Frontent Codebase:

     cd frontend/

   • Install dependencies:

     npm install

   • Add Environment Variables:

     Create .env file in the root folder and copy paste the content of .env.sample

     cp .env.sample .env

     If required, update necessary credentials.

   • Start the frontend app:

     npm run dev

   • Start the backend server:

     cd ../backend
     npm run dev 

   • Open app in browser:

     Visit https://localhost:5174 to access frontent.

🤝  Contributing

Contributions are always welcome!