Skip to content

a fully-functional skeleton application that you can use for your new applications.

License

Notifications You must be signed in to change notification settings

rxstack/skeleton

Repository files navigation

RxStack Skeleton Application

Node.js CI Maintainability Test Coverage

a fully-functional skeleton application that you can use for your new applications.

For more details please visit the official documentations.

Project folder and file structure

  • src - all your code lives here
    • index.ts - application entry file
    • cli.ts - CLI entry file
    • worker.ts - worker entry file
    • app - application related files
      • app.ts - application instance.
      • APPLICATION_OPTIONS.ts - all application configurations read more.
      • commands - command line application files read more.
      • controllers - all your controller files read more.
      • event-listeners - all your event listener files read more.
      • workers - worker tasks read more.
    • environments - configuration files read more.
  • test - all tests files
  • static - all static files
  • mocha.opts - mocha options
  • tslint.json - typescript linter configuration
  • tsconfig.json - typescript configuration

NPM scripts

  • $ npm run dev - compiles and starts nodemon
  • $ npm run compile - compiles the source code
  • $ npm run watch - watching for file changes
  • $ npm run clean - removes the dist directory
  • $ npm run lint - lints the source code using tslint.json
  • $ npm run mocha - runs tests using mocha.opts
  • $ npm run coverage - runs tests with nyc
  • $ npm test - runs lint, mocha and coverage
  • $ npm run cli - runs command line applications from dist directory
  • $ npm run cli-dev - runs command line applications with ts-node

License

Licensed under the MIT license.