/course-review

Course Review App: TypeScript, Express.js, MongoDB-powered platform for efficient course management. Robust error handling, validation, and diverse endpoints ensure seamless creation, updating, and retrieval of courses, categories, and reviews.

Primary LanguageTypeScriptMIT LicenseMIT

course-review

This project is a Course Review Application built using TypeScript, Express.js, and MongoDB. It provides a platform to manage courses, categories, and reviews. The application follows a specific technology stack and includes error handling, validation, and various endpoints for creating, updating, and retrieving data.

Table of Contents

Technology Stack

  • Programming Language: TypeScript
  • Web Framework: Express.js
  • Object Data Modeling (ODM): Mongoose for MongoDB
  • Validation Library: Zod
  • Deployment: Vercel

Models

Course Model

  • _id (Object ID): A distinctive identifier generated by MongoDB.
  • title (String): A unique title of the course.
  • instructor (String): The instructor of the course.
  • categoryId (Object ID): A reference to the category collection.
  • price (Number): The price of the course.
  • tags (Array of Object): An array of objects with "name" (string) and "isDeleted" (boolean) properties.
  • startDate (String): The start date of the course.
  • endDate (String): The end date of the course.
  • language (String): The language in which the course is conducted.
  • provider (String): The provider of the course.
  • durationInWeeks (Integer): The overall duration of the course in weeks.
  • details (Object):
    • level (string): e.g., Beginner, Intermediate, Advanced.
    • description (string): Detailed description of the course.

Category Model

  • _id (Object ID): A distinctive identifier generated by MongoDB.
  • name (String): A unique name of the category.

Review Model

  • _id (Object ID): A distinctive identifier generated by MongoDB.
  • courseId (Object ID): A reference to the course collection.
  • rating (Number): Rating, which falls within the range of 1 to 5.
  • review (String): The comment or review text provided by the user.

Folder Structure

  • src/: Contains all the source code files.
  • dist/: Contains all the compiled and minified source code files.

Dependencies

  • cors: 2.8.5
  • dotenv: 16.3.1
  • express: 4.18.2
  • http-status: 1.7.3
  • mongoose: 8.0.3
  • zod: 3.22.4

Error Handling

The application implements proper error handling throughout, using a global error handling middleware. It provides appropriate error responses with status codes and error messages. The error response object includes information about the error type, a concise error message, detailed error information, and a stack trace for debugging purposes.

Endpoints

  1. Create a Course - POST /api/course

    • send a request in JSON format with the mentioned fields in the request body
    • returns created course with success message

  2. Get Paginated and Filtered Courses - GET /api/courses

    Query Parameters

    • page: (Optional) Specifies the page number for paginated results. Default is 1.
    • limit: (Optional) Sets the number of items per page. Default is 10.
    • sortBy: (Optional) Specifies the field by which the results should be sorted. Applicable values are: title, price, startDate, endDate, language, durationInWeeks, provider, level.
    • sortOrder: (Optional) Determines the sorting order, either asc (ascending) or desc (descending).
    • minPrice, maxPrice: (Optional) Filters results by a price range.
    • tags: (Optional) Filters results by the name of a specific tag.
    • startDate, endDate: (Optional) Filters results by a date range.
    • language: (Optional) Filters results by the language of the course.
    • provider: (Optional) Filters results by the course provider.
    • durationInWeeks: (Optional) Filters results by the duration of the course in weeks.
    • level: (Optional) Filters results by the difficulty level of the course.

  3. Create a Category - POST /api/categories

    • send a request in JSON format with the mentioned fields in the request body
    • returns created category with success message

  4. Get All Categories - GET /api/categories

    • returns all categories with success message

  5. Create a Review for a Course - POST /api/reviews

    • send a request in JSON format with the mentioned fields in the request body
    • returns created review with success message

  6. Update a Course - PUT /api/courses/:courseId

    • it supports partial update with dynamic update
    • send a request in JSON format with the mentioned fields in the request body
    • returns updated course with success message

  7. Get a Course with Reviews - GET /api/courses/:courseId/reviews

    • returns the course with its reviews and success message

  8. Get the Best Course by Average Rating - GET /api/course/best

    • returns the best course with success message and the average rating with total number of reviews

How to Run the Project

Prerequisites

  • Node.js v20 or later
  • MongoDB v5.0 or later
  • Mongoose v7.0 or later

Installation

  1. Clone the repository

    git clone https://github.com/MuzakkirHossainMinhaz/course-review.git

  2. Navigate to the project directory

    cd course-review

  3. Install dependencies

    `npm install` or `npm i`

  4. Setup Environment Variables

    // create a `.env` file in the root directory and add the following variables

PORT=5000 or as_your_wish
NODE_ENV=DEVELOPMENT
DATABASE_URL=your_mongodb_url

  5. Start the server

    npm run start:dev

  6. Open your browser and navigate to http://localhost:5000

How to Contribute

We welcome contributions! If you want to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your fork.
  5. Submit a pull request to the main branch of the original repository.

About the Author

Acknowledgements

License

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