Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 1.73 KB

README.md

File metadata and controls

61 lines (41 loc) · 1.73 KB
Raw

Minimal Express

Setup

# install dependencies
$ npm i -D

# perform initial build
$ npm run build

Setting up environment

An example file for environment variables is provided. It can be copied to define actual environment variables.

# create a new .env file from .env.example file
$ cp .env.example .env

Note: The .env file will be loaded during development and testing. It will not be loaded in production. If you require that .env file be loaded in production environment as well, please update the package.json scripts accordingly.

Generating security keys

The application depends of security keys to operate securely. They must be defined inside the .env file. A script has been included for easily generate these keys. Run the following command to generate a crypt-random key.

$ npm run gen:secret

Run in Development Mode

$ npm run start:dev

Running Tests with Jest

$ npm test

Run in Production Mode

$ npm run build
$ npm run start:prod

Note: The NODE_ENV environment variable will be set to production when running the app in production mode.

Serving static files

The web server has been setup to server static files. This behavior is not enabled by default but can be enabled by updating src/config.ts file and setting server.public.exposePublicFolder to true.

The web server has been setup to server static files from public folder located at the root of the project. These files will be served from root url of the server. E.g. File public/manifest.json will be served at https://domain.com/manifest.json.

TODO

  • Enable rate-limiting
  • Add health-check end-points
  • Add end-point tests