/ts-node-boilerplate

Primary LanguageJavaScriptMIT LicenseMIT

Get Started

Suggested folder structure

  • root

    • *** bundle/

    • constants/

    • ** core/

      • index.core.ts

    • models/

    • playground/

    • ** src/

      • index.ts

    • test/

    • types/

    • utils/

** : initially provided directories

*** : build output directory

Commands

initially you need to install packages ! using yarn install or npm install

developement

  • running developement version
    npm run dev
    // or
    yarn dev

build

  • build the project
    npm run build
    // or
    yarn build
  • running the built version
    npm run start
    // or
    yarn start

playground

  • running playground code
    npm run play
    // or
    yarn play

test

  • running unit tests inside test/ directory
    npm run test
    // or
    yarn test