Skip to content

Instantly share code, notes, and snippets.

@etienne-napoleone
Last active September 13, 2024 07:54
Show Gist options
  • Select an option

  • Save etienne-napoleone/1364c5b851cfcc4e5a94d3de558dd6d7 to your computer and use it in GitHub Desktop.

Select an option

Save etienne-napoleone/1364c5b851cfcc4e5a94d3de558dd6d7 to your computer and use it in GitHub Desktop.
Technial readme

Project name

General description: what does it do, what does it interact with, etc.

Requirements

  • Node >= vX.X

Installation

With npm:

npm i project-name

Usage

Configuration

The configuration is provided through the following environment variables at runtime:

Name Required Default Description
REDIS_HOST yes Redis host url
REDIS_PORT no 6379 Redis host port

Run

Run worker:

npm run worker

Run server:

npm run server

Development

Build

Build assets:

npm run build

Tests

Run tests:

npm run tests

Run end to end tests:

npm run e2e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment