Quiz App Documentation

Table of Contents

1. Project Overview
2. Features
3. Technologies Used
4. Installation
5. Folder Structure
6. API Endpoints
7. Running the App
8. Contributing
9. License

Project Overview

The Quiz App is a full-stack web application that allows users to take quizzes on various topics. Users can view available quizzes, take them, and see their results. Administrators can create, update, and delete quizzes. The application is built using React for the front end and Node.js with Express for the back end.

Features

• User authentication and authorization
• Create, read, update, and delete quizzes
• Take quizzes and see results
• Responsive design for mobile and desktop

Technologies Used

Front End

• React
• Redux
• Axios
• React Router

Back End

• Node.js
• Express
• MongoDB (Mongoose)
• JWT for authentication
• Bcrypt for password hashing

Other

• Docker for containerization
• Jest for testing

Installation

To run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/quiz-app.git
   cd quiz-app

2. Install dependencies for both the client and server:

   cd frontend
   npm install
   cd ../backend
   npm install

3. Set up environment variables. Create a .env file in the server directory and add the following:

   MONGO_URI=your_mongodb_uri
   JWT_SECRET=your_jwt_secret

4. Start the development servers:

   npm start
   
   

Folder Structure

quiz-app/
│
├── client/             # React front end
│   ├── public/
│   └── src/
│       ├── components/
│       ├── pages/
│       ├── redux/
│       ├── App.js
│       ├── index.js
│       └── ...
│
├── server/             # Node.js back end
│   ├── config/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── app.js
│   └── server.js
│
├── .gitignore
├── README.md
└── package.json