intelli-module v1.0.0

Express app bolierplate

This is a bolierplate to create a new express app, this template does not contain any database connection solution instead we use axios request to hasura

Installation

Set the environment variables:

cp .env.example .env
# open .env and modify the environment variables (if needed)

Run proyect

Go to app directory

cd app

Install the dependencies:

npm install

yarn

Table of Contents

• Features
• Commands
• Environment Variables
• Project Structure
• Error handling
• Project Structure
• Linting

Features

• Testing: unit and integration tests using Jest
• Error handling: centralized error handling mechanism
• Dependency management: with Yarn
• Environment variables: using dotenv and cross-env
• Linting: with ESLint and Prettier

Commands

Running with nodemon watcher:

npm run dev

Running locally:

npm start

Testing:

# run all tests
yarn test

# run all tests in watch mode
yarn test:watch

Linting:

# run ESLint
yarn lint

# fix ESLint errors
yarn lint:fix

# fix prettier errors
yarn prettier:fix

Environment Variables

The environment variables can be found and modified in the .env file. They come with these default values:

# Port number
PORT=3000
#node env (only 'dev' and 'prod')
NODE_ENV=dev

Project Structure

app\
  |--src\
    |--config\         # Environment variables and configuration related things
    |--middlewares\    # Custom express middlewares
    |--routes\         # Routes
    |--services\       # Functions and services for routes
    |--tests\          # Tests folder
      |--middlewares   
      |--routes
      |--services
    |--utils\          # Utility classes and functions
    |--app.js          # Express app
    |--index.js        # App entry point

Error handling

The app has a utility ApiError class to which you can attach a response code and a message, and then throw it from anywhere (catchAsync will catch it).

For example, if you are trying to get a user from the DB who is not found, and you want to send a 404 error, the code should look something like:

const httpStatus = require('http-status');
const ApiError = require('../utils/ApiError');
const User = require('../models/User');

const getUser = async (userId) => {
  const user = await User.findById(userId);
  if (!user) {
    throw new ApiError(httpStatus.NOT_FOUND, 'User not found');
  }
};

Linting

Linting is done using ESLint and Prettier.

In this app, ESLint is configured to follow the Airbnb JavaScript style guide with some modifications. It also extends eslint-config-prettier to turn off all rules that are unnecessary or might conflict with Prettier.

To modify the ESLint configuration, update the .eslintrc.json file. To modify the Prettier configuration, update the .prettierrc.json file.

To prevent a certain file or directory from being linted, add it to .eslintignore and .prettierignore.

To maintain a consistent coding style across different IDEs, the project contains .editorconfig