Real time quiz website

This real-time quiz application, built with Next.js, Socket.io and Prisma, offers real time communication.It shows a leaderboard with the highest ratings and gives you the chance to compete with others.

Table of Contents

1. Features
2. Tech Stack
3. Getting Started
4. Installation
5. Configuration
6. Running the Project
7. Folder Structure
8. Contributing
9. License

Features

• Answer Question: Answer questions in real time.
• Competition: Compete with people around the world.
• View Leaderboard: View people who are ahead of you.
• Save Info: Preserve information for future games.
• Improve Skills: Improve logical reasoning.

Sample Image:

Tech Stack

• Next.js
• TypeScript
• Socket.io
• Prisma
• PostgreSQL
• Tailwind CSS

Getting Started

Follow the instructions below to set up the project locally on your machine.

Prerequisites

• Node.js (v16 or later): Download Node.js
• Git: Download Git
• PostgreSQL: Install PostgreSQL (Not Necessary)

Installation

1. Clone the repository:

   git clone https://github.com/centauricoder01/real-time-quiz-website.git
   

2. Navigate to the project directory:

   cd real-time-quiz-website
   

3. Install dependencies:

   npm install

Configuration

Create a .env file in the root directory of your project and add the following environment variables:

DATABASE_URL=postgresql://user:password@localhost:5432/quiz-website
NEXT_PUBLIC_APP_URL="http://localhost:3000"

Running Migrations

 npx prisma migrate dev

Running the Project

  npm run dev

Build for production:

  npm run build

Folder Structure

ai-plagiarism-detector/
├── public/         # Static assets
├── src/            # Source files
│   ├── app/
      ├── api/     #All APIs
      ├── other_page/     #Other Pages
│   ├── components/  # Reusable components
│   ├── hooks/      # custom hooks
│   └── libs/      # Utility functions
├── .env.local      # Environment variables
├── next.config.js  # Next.js configuration
├── package.json    # Dependencies and scripts
├── README.md       # Project documentation
└── tsconfig.json   # TypeScript configuration

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.

1. Fork the repository:

   Go to the repository on GitHub and click the "Fork" button at the top right corner.

2. Create a feature branch:

   git checkout -b feature-name
   

3. *Commit your changes:

   git commit -m 'Add some feature'
   

4. Push to the branch:

   git push origin feature-name

Thank you for your contribution! If you found this project helpful, please consider giving it a star ⭐.

License

This project is licensed under the MIT License. See the LICENSE file for more details.