An open API service indexing awesome lists of open source software.

https://github.com/taronvardanyan/vidly

Video renting application for beginners in node.js
https://github.com/taronvardanyan/vidly

expressjs jwt mongodb mongoose nodejs

Last synced: 8 months ago
JSON representation

Video renting application for beginners in node.js

Awesome Lists containing this project

README

          


Vidly

Vidly is an Express application for managing a video rental service. It includes functionalities such as user authentication, video rental management, and more.

Features




  • User Authentication: Secure authentication using JSON Web Tokens and bcrypt for password hashing.


  • Data Validation: Validate data using Joi.


  • Database: Use MongoDB and Mongoose for data storage and manipulation.


  • Security: Enhance security with Helmet.


  • Logging: Log requests and errors using Morgan and debug.


  • Views: Render views using Pug template engine.

Getting Started




  1. Installation: Clone the repository and install dependencies.

  2. git clone https://github.com/TaronVardanyan/vidly.git
    
    cd vidly
    bun install


  3. Environment Variables: Set up environment variables. Create a .env file in the root directory and add the necessary configurations (e.g., database URL, JWT secret).


  4. Development: Start the development server.

  5. bun dev
    

Dependencies




  • bcrypt: Password hashing.


  • config: Application configuration.


  • debug: Debugging utility.


  • express: Web framework for Node.js.


  • fawn: Transactions in MongoDB.


  • helmet: Security middleware.


  • joi: Data validation library.


  • jsonwebtoken: JSON Web Token implementation.


  • mongodb: MongoDB driver for Node.js.


  • mongoose: MongoDB object modeling tool.


  • morgan: HTTP request logger middleware.


  • nodemon: Utility that monitors for changes and automatically restarts the server.


  • pug: Template engine.

Scripts




  • test: Placeholder for running tests (currently not specified).

Contributing


We welcome contributions to Vidly! To contribute:



  1. Fork the repository.

  2. Create a new branch (git checkout -b feature/my-feature).

  3. Commit your changes (git commit -am 'Add new feature').

  4. Push to the branch (git push origin feature/my-feature).

  5. Create a new Pull Request.

License


This project is licensed under the ISC License.