kunjan343 / typenode

Advance typescript node server totally flexible with customization for enterprise applications. No overhead, No unnecessary customization, No custom guideline. Follow your own standards with simplicity.

Node.js seed project for typescript starter server

Enjoy, Like, Love the project? Drop a star and spread the word.(More feature will come soon)
Live server: Heroku

Pre-require library

• npm install -g nodemon
• npm install -g ts-node
• npm install -g tslint
• npm install -g typedoc
  or
• Setup run commands to use it from local dependency.

Installing dependency

• Run npm install to install app dependency.
• Use npm install --save ****** to install new dependency or npm install --save-dev ****** to install dev-dependency/types.

Running project

• Run set(windows)/export(linux) NODE_ENV=development/production.
• This project uses nodemon to auto reflect new changes on development time.
• Simply run npm run live to reflect new changes.

Production server

• Run npm run build to build project into javascript es2015 target.
• Run npm start to run the build project.

Running test cases

• Run npm test to run test cases.

Ts-lint project

• Run npm run lint to perform tslint on all source files.
• Config tslint.json to prefer your coding style.

Extras

• This sample application has automation with Travis + Heroku + Codecov to demonstrate complete application cycle.
• Use your own heroku key to deploy on your server.
• Add project into travis or modify travis.yml for your settings.
• Export your own codecov key in travis to auto upload converge reports.

Badges

• Build badge is from Travis.
• Code coverage badge is from Codecov.
• Code quality badge is from Codacy.

Core Libraries

• ExpressJS - node web framework
• TypeORM - TypeScript ORM framework for database operation
• InversifyJS - TypeScript DI/IoC framework
• Winston - provide logging on runtime development.