Skip to content

Latest commit

 

History

History
58 lines (30 loc) · 1.65 KB

readme.md

File metadata and controls

58 lines (30 loc) · 1.65 KB

Introduction

This is the backend of Vidly, a video rental application. It is constantly updated with features; frontend is to be added soon.

Setup

Make sure to follow all these steps exactly as explained below. Do not miss any steps or you won't be able to run this application.

Install MongoDB

To run this project, you need to install the latest version of MongoDB Community Edition first.

https://docs.mongodb.com/manual/installation/

Once you install MongoDB, make sure it's running.

Install the Dependencies

Next, from the project folder, install the dependencies:

npm i

Populate the Database (not functional in this version; to be updated)

node seed.js

Run the Tests

You're almost done! Run the tests to make sure everything is working:

npm test

All tests should pass.

Start the Server

node index.js

This will launch the Node server on port 8000. If that port is busy, you can set a different point in config/default.json.

Open up your browser and head over to:

http://localhost:8000/api/genres

You should see the list of genres. That confirms that you have set up everything successfully.

(Optional) Environment Variables

If you look at config/default.json, you'll see a property called jwtPrivateKey. This key is used to encrypt JSON web tokens. So, for security reasons, it should not be checked into the source control. I've set a default value here to make it easier for you to get up and running with this project. For a production scenario, you should store this key as an environment variable.

On Windows:

$env:vidly_jwtPrivateKey=yourSecureKey

On Mac:

export vidly_jwtPrivateKey=yourSecureKey