express-locallibrary-tutorial

express-locallibrary-tutorial

Tutorial "Local Library" website written in in Node/Express.

This web application creates an online catalog for a small local library, where users can browse available books and manage their accounts.

[A UML diagram showing the relation of database entities in this example repository]

For more information see the associated MDN tutorial home page.

Note The auth branch in this repository implements an unsupported and undocumented version of the library with User Authentication and Authorization. This may be a useful starting point for some users.

Quick Start

To get this project up and running locally on your computer:

1. Set up a Node.js development environment.

2. Once you have node setup install the project in the root of your clone of this repo:

   npm install
   

3. Run the tutorial server, using the appropriate command line shell for your environment:

   # Linux terminal
   DEBUG=express-locallibrary-tutorial:* npm run devstart
   
   # Windows Powershell
   $ENV:DEBUG = "express-locallibrary-tutorial:*"; npm start
   

4. Open a browser to http://localhost:3000/ to open the library site.

[!NOTE] The library uses a default MongoDB database hosted on MongoDB Atlas. You should use a different database for your own code experiments.

Contributing

The project is the result of carefully running through all the steps in the tutorial on MDN. Any changes to either MDN or this project must be synchronized. Generally it is better to implement changes here before submitting them to MDN.

Before submitting a PR, make sure that the tests pass:

npm test