https://github.com/kaungkhantkyaw1997/quiz-trove

Quiz Trove is an online platform for creating and managing quizzes, allowing users to test their knowledge and track progress.
https://github.com/kaungkhantkyaw1997/quiz-trove

education express learning mongodb quiz

Last synced: 22 days ago
JSON representation

Quiz Trove is an online platform for creating and managing quizzes, allowing users to test their knowledge and track progress.

• Host: GitHub
• URL: https://github.com/kaungkhantkyaw1997/quiz-trove
• Owner: KaungKhantKyaw1997
• License: mit
• Created: 2024-10-17T15:09:18.000Z (29 days ago)
• Default Branch: main
• Last Pushed: 2024-10-17T15:31:03.000Z (29 days ago)
• Last Synced: 2024-10-20T18:39:30.763Z (26 days ago)
• Topics: education, express, learning, mongodb, quiz
• Language: JavaScript
• Homepage: https://quiz-trove.onrender.com/api-docs/
• Size: 34.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quiz Trove

**Quiz Trove** is an online quiz application that allows users to create quizzes, add questions, and test their knowledge.

## Getting Started

### Prerequisites

- Node.js

- MongoDB

### Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/KaungKhantKyaw1997/quiz-trove.git

   cd quiz-trove

   ```

2. Install dependencies:

   ```bash

   npm install

   ```

3. Create a `.env` file with your MongoDB URI, JWT secret, token expiration time, and Node environment.

### Running the Application

To start the server, run:

```bash

npm start

```

### API Documentation

The API is documented using **Swagger**. You can access the documentation at:

```bash

http://localhost:5001/api-docs

```

### API Endpoints

**Authentication**

- **Log in a user**

  - `POST /api/v1/auth/login`

**User Management**

- **Create a new user**

  - `POST /api/v1/users`

- **Update a user**

  - `PUT /api/v1/users/{id}`

- **Delete a user**

  - `DELETE /api/v1/users/{id}`

**Quizzes**

- **Create a new quiz**

  - `POST /api/v1/quizzes`

- **Get all quizzes**

  - `GET /api/v1/quizzes`

- **Get a quiz by ID**

  - `GET /api/v1/quizzes/{id}`

- **Update a quiz**

  - `PUT /api/v1/quizzes/{id}`

- **Delete a quiz**

  - `DELETE /api/v1/quizzes/{id}`

**Questions**

- **Add a question to a quiz**

  - `POST /api/v1/quizzes/{quizId}/questions`

- **Get all questions of a quiz**

  - `GET /api/v1/quizzes/{quizId}/questions?page={page}&limit={limit}`

- **Update a question in a quiz**

  - `PUT /api/v1/quizzes/{quizId}/questions/{questionId}`

- **Delete a question from a quiz**

  - `DELETE /api/v1/quizzes/{quizId}/questions/{questionId}`

- **Upload multiple questions from an Excel file**

  - `POST /api/v1/quizzes/{quizId}/questions/upload`