|
1 | 1 | # npm-template-typescript |
2 | 2 |
|
3 | | -Supports javascript developers who use npm to publish and share package quicker. Less time to setup utility tools to follow best-practices and more time on the core features of the package. |
| 3 | +[](https://github.com/make-everything-simple/npm-template-typescript//actions/workflows/ci.yml?query=branch%3Amain) |
| 4 | +[](https://github.com/make-everything-simple/npm-template-typescript//actions/workflows/publish.yml) |
| 5 | +[](https://npmjs.org/package/@make-everything-simple/npm-template-typescript) |
| 6 | +[](https://packagephobia.com/result?p=@make-everything-simple%2Fnpm-template-typescript) |
| 7 | +[](https://npmcharts.com/compare/@make-everything-simple/npm-template-typescript?minimal=true) |
| 8 | + |
| 9 | +Supports javascript developers who use npm to publish and share package quicker. Less time to setup utility tools to follow best-practices, more time on the core features of the package. |
4 | 10 |
|
5 | 11 | ## Prerequisites |
6 | 12 |
|
@@ -41,7 +47,7 @@ npm run prettier:format | yarn prettier:format |
41 | 47 | ### Clone the repository |
42 | 48 |
|
43 | 49 | ```bash |
44 | | -git clone git@github.com:lengocduy/npm-template-typescript.git |
| 50 | +git clone git@github.com:make-everything-simple/npm-template-typescript.git |
45 | 51 | cd npm-template-typescript |
46 | 52 | npm install | yarn install |
47 | 53 | ``` |
@@ -72,11 +78,11 @@ npm pkg fix |
72 | 78 | 1. We use the git rebase strategy to keep tracking meaningful commit message. Help to enable rebase when pull `$ git config --local pull.rebase true` |
73 | 79 | 2. Follow TypeScript Style Guide [Google](https://google.github.io/styleguide/tsguide.html) |
74 | 80 | 3. Follow Best-Practices in coding: |
75 | | - - [Clean code](https://github.com/labs42io/clean-code-typescript) make team happy |
76 | | - - [Return early](https://szymonkrajewski.pl/why-should-you-return-early/) make code safer and use resource Efficiency |
77 | | - - [Truthy & Falsy](https://frontend.turing.edu/lessons/module-1/js-truthy-falsy-expressions.html) make code shorter |
78 | | - - [SOLID Principles](https://javascript.plainenglish.io/solid-principles-with-type-script-d0f9a0589ec5) make clean code |
79 | | - - [DRY & KISS](https://dzone.com/articles/software-design-principles-dry-and-kiss) avoid redundancy and make your code as simple as possible |
| 81 | + 1. [Clean code](https://github.com/labs42io/clean-code-typescript) make team happy |
| 82 | + 2. [Return early](https://szymonkrajewski.pl/why-should-you-return-early/) make code safer and use resource Efficiency |
| 83 | + 3. [Truthy & Falsy](https://frontend.turing.edu/lessons/module-1/js-truthy-falsy-expressions.html) make code shorter |
| 84 | + 4. [SOLID Principles](https://javascript.plainenglish.io/solid-principles-with-type-script-d0f9a0589ec5) make clean code |
| 85 | + 5. [DRY & KISS](https://dzone.com/articles/software-design-principles-dry-and-kiss) avoid redundancy and make your code as simple as possible |
80 | 86 | 4. Make buildable commit and pull latest code from `main` branch frequently |
81 | 87 | 5. Use readable commit message [karma](http://karma-runner.github.io/6.3/dev/git-commit-msg.html) |
82 | 88 |
|
|
0 commit comments