Giter VIP home page Giter VIP logo

education-app's Introduction

NestJS Udemy Clone

This repository contains a clone project of Udemy built with NestJS. This project aims to replicate some of the core functionalities of the Udemy platform using the NestJS framework.

Presentation

This project serves as a learning resource for understanding how to build robust backend applications using NestJS, a progressive Node.js framework. It demonstrates various features of NestJS, including:

  • Controllers and Routing
  • Dependency Injection
  • Middleware
  • Authentication and Authorization
  • Database Integration (e.g., TypeORM, MongoDB)
  • Error Handling
  • Testing (e.g., Unit Testing, End-to-End Testing)

By exploring this project, developers can gain insights into best practices for structuring and implementing backend applications with NestJS.

Commands

To run the NestJS Udemy clone project locally, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/anarbyrm/education-app.git
    
  2. Install Dependencies:

    cd education-app
    npm install
    
  3. Start the Development Server:

    npm run start:dev
    

This command will start the development server. The server runs on: http://localhost:.

  1. Set Up Environment Variables:

Before running the project, make sure to set up the necessary environment variables. Refer to the Environment Variables section below for a list of required variables.

The following environment variables need to be set up for the NestJS Udemy clone project to function correctly:

NODE_ENV=
HOST=
PORT=

JWT_SECRET=
AVATAR_MAX_SIZE=

SMTP_HOST=
SMTP_PORT=
SMTP_USERNAME=
SMTP_PASSWORD=
SMTP_SENDER=

SECRET=
VECTOR=
(Add any additional environment variables if necessary)

Make sure to provide appropriate values for these variables in your development environment. You can set these variables in a .env file located in the root directory of the project.

  1. Explore the API Endpoints:

Once the server is running, you can explore the available API endpoints using:

  • tools like Postman or cURL.
  • swagger API doc at "/docs" endpoint

education-app's People

Contributors

anarbyrm avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.