Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.39 KB

README.md

File metadata and controls

30 lines (24 loc) · 1.39 KB

template-node-package

npm TypeScript compatible Code Style Prettier Dependencies State

Template for node Packages written in TypeScript, Features Jest, Eslint, Prettier

Things ToDo

When initialised, you will need to update the following;

  1. Update Package name, description, author, repository, bugs, keywords fields found in the package.json file.
  2. Update LICENSE file as well as license field on the package.json file.
  3. Update this README.md file to contain your package specific information. Update the following;
    • Replace all occurrences of template-node-package on this file.
    • Replace all occurrences of mernxl with appropriate, mernxl in this case is my username.
  4. Remove the .gitkeep file in src directory
  5. Run yarn install

🚀 Happy Coding from mernxl 🚀

Installation

yarn add template-node-package
or
npm install template-node-package

License

This project is MIT Licensed - see the LICENSE.md file for details