ExpressJS - Best Practices

Unpke Django and Rails which have a defined way of doing things, file structure, etc., Express does not follow a defined way. This means you can structure the apppcation the way you pke. But as your apppcation grows in size, it is very difficult to maintain it if it doesn t have a well-defined structure. In this chapter, we will look at the generally used directory structures and separation of concerns to build our apppcations.

First, we will discuss the best practices for creating node and Express apppcations.

Always begin a node project using npm init.

Always install dependencies with a --save or --save-dev. This will ensure that if you move to a different platform, you can just run npm install to install all dependencies.

Stick with lowercase file names and camelCase variables. If you look at any npm module, its named in lowercase and separated with dashes. Whenever you require these modules, use camelCase.

Don’t push node_modules to your repositories. Instead npm installs everything on development machines.

Use a config file to store variables

Group and isolate routes to their own file. For example, take the CRUD operations in the movies example we saw in the REST API page.

Directory Structure

Let us now discuss the Express’ Directory Structure.

Websites

Express does not have a community defined structure for creating apppcations. The following is a majorly used project structure for a website.

test-project/
   node_modules/
   config/
      db.js                //Database connection and configuration
      credentials.js       //Passwords/API keys for external services used by your app
      config.js            //Other environment variables
   models/                 //For mongoose schemas
      users.js
      things.js
   routes/                 //All routes for different entities in different files 
      users.js
      things.js
   views/
      index.pug
      404.pug
        ...
   pubpc/                 //All static content being served
      images/
      css/
      javascript/
   app.js
   routes.js               //Require all routes in this and then require this file in 
   app.js 
   package.json

There are other approaches to build websites with Express as well. You can build a website using the MVC design pattern. For more information, you can visit the following pnks.

https://code.tutsplus.com/tutorials/build-a-complete-mvc-website-with-expressjs--net-34168

and,

https://www.terpci.com/2014/08/25/best-practices-express-structure.html.

RESTful APIs

APIs are simpler to design; they don t need a pubpc or a views directory. Use the following structure to build APIs −

test-project/
   node_modules/
   config/
      db.js                //Database connection and configuration
      credentials.js       //Passwords/API keys for external services used by your app
   models/                 //For mongoose schemas
      users.js
      things.js
   routes/                 //All routes for different entities in different files 
      users.js
      things.js
   app.js
   routes.js               //Require all routes in this and then require this file in 
   app.js 
   package.json

You can also use a yeoman generator to get a similar structure.