MDB-lite

A movie management system built using NodeJS and MongoDB.

Explore the docs »
View Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Local
   • Deployment
4. TO-DO
5. Contributing

About The Project

A movie management system built using NodeJS, ExpressJS and MongoDB consisting of CRUD features like ratings and blogs for movies, and comments(replies) for a particular blog. Admin have some privileged permissions like CRUD operations for movies, delete any blog/comment/user account. Users can update their profile and also view others’ profile by searching by username.

Built With

Major Frameworks/Libraries used:

• NodeJS
• MongoDB Atlas
• ExpressJS

Getting Started

To setup the project locally, follow the given steps:

Prerequisites

Following software needs to be setup in the system:

• git
• github-cli (optional)
• nodejs
• Either mongodb installed or MongoDB Atlas account (please refer to corresponding links to setup respective software)

Installation

1. Clone the repo by

   git clone https://github.com/SubhradeepSS/MDB-lite.git

   or (if github-cli is installed)

   gh repo clone SubhradeepSS/MDB-lite

2. Navigate to the project directory.
3. To install the required packages, open cli/terminal and run

   npm install

4. Create a .env file in the project root directory which consists of the following content:

   DB = {the mongodb uri either setup locally or the uri from mongodb atlas}

Usage

Local

For running the project, navigate to the project directory and follow the given instructions:

• For running the development server, open terminal/cli and run:

    npm run dev

• For testing the server:

    npm run start

• Open http://localhost:3000/ in browser and the login page of the project will open.

• Create a user(by signing up from the site itself) with username: admin so as to give the user privileged permissions of an admin.

• New users can signup by providing details and existing users can login with their credentials.

Deployment

View deployed site here. NOTE: the deployment might not function always since mongodb-atlas requires whitelisting of IPs to access the database.

Credentials for admin:

User Type	Username	Password
admin	admin	password
normal user	user	password

TO-DO

Following features/enhancements are thought to be added later:

• UI enhancement.
• Implement CASCADE delete for mongoose models.

Contributing

Any contributions made to the project are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request