Skip to content

TRIPTYK/nfw

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

alt text

NFW a node Typescript boilerplate

Test Lint CodeQL

This repository contains a JSON-API REST API boilerplate using NFW-CORE.

Requirements

  • Typescript >= 4.5.x
  • node >= 16.x
  • pnpm

Install

Any package manager should do the trick but i recommend using Pnpm.

pnpm i

Start

You must create a <NODE_ENV>.js file for each env at the root of your project.

The structure of the env file can be found in the configuration service.

Dev

pnpm start:dev

Test

pnpm start:test

Production

You need to transpile the Typescript because executing the command.

pnpm tsc && pnpm start:production

Tests & Lint

pnpm test
pnpm lint

Mikro-orm CLI

pnpm mikro-orm:cli <any command>