Skip to content

h3nrzi/vidly

Repository files navigation

ts-express-vidly-api

This is a rental movie API built with TypeScript, Express, and MongoDB.

Getting Started

Installation

To install the dependencies, run the following command:

npm install

Running the Application

To start the application, run the following command:

npm run start

This will start the application in production mode.

Development Mode

To start the application in development mode, run the following command:

npm run start:dev

This will start the application with nodemon, which will automatically restart the application when changes are made to the code.

Testing

To run the tests, run the following command:

npm run test

This will run the tests using Jest.

Dependencies

This project depends on the following packages:

  • @babel/preset-typescript
  • bcrypt
  • compression
  • config
  • debug
  • express
  • express-async-errors
  • helmet
  • jest
  • joi
  • jsonwebtoken
  • lodash
  • moment
  • mongoose
  • morgan
  • pug
  • ts-jest
  • ts-node
  • typescript
  • winston
  • winston-mongodb

Dev Dependencies

This project uses the following dev dependencies:

  • @types/bcrypt
  • @types/compression
  • @types/config
  • @types/express
  • @types/helmet
  • @types/jest
  • @types/joi
  • @types/jsonwebtoken
  • @types/lodash
  • @types/mongoose
  • @types/morgan
  • @types/node
  • @types/supertest
  • nodemon
  • supertest

Author

Hossein Rezaei

Node Version

This project requires Node.js version 20.10.0 or higher.