-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
21,134 additions
and
20,846 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| <!-- all-shields/header-badges:START --> | ||
|
|
||
| [](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/node-cli-boilerplate) [](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/LICENSE.md) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io) | ||
| [](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/node-cli-boilerplate) [](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/LICENSE.md) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io) | ||
|
|
||
| <!-- all-shields/header-badges:END --> | ||
|
|
||
|
|
@@ -28,6 +28,7 @@ This is a [github template](https://github.blog/2019-06-06-generate-new-reposito | |
| - 🔨 [Developer Mode](#-developer-mode) | ||
| - - 🏁 [Run Project](#-run-project) | ||
| - - 💾 [Setup Project](#-setup-project) | ||
| - - 🚀 [Deploy](#-deploy) | ||
| - 👨💻 [Contributing](#-contributing) | ||
| - 🐛 [Known Bugs](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/issues?q=is%3Aopen+is%3Aissue+label%3Abug) | ||
| - 🍻 Community: | ||
|
|
@@ -63,16 +64,27 @@ You can use npx, example: `npx @ptkdev/node-cli-boilerplate` | |
|
|
||
| 1. Clone this repository or download [nightly](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/nightly.zip), [beta](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/beta.zip) or [stable](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/main.zip). | ||
| 2. Run `npm install` | ||
| 3. Run `npm run build` | ||
| 4. Run `npm run link` | ||
| 5. Run `node-cli-boilerplate` anywhere for execute command line tool | ||
| 3. Run `npm run dev` for watch mode | ||
|
|
||
| or run `npm run dev` for watch mode. | ||
| If you want to try cli locally: | ||
|
|
||
| 4. Run `npm run build` | ||
| 5. Run `npm link` (on unix/mac use `sudo npm link`) | ||
| 6. Run `node-cli-boilerplate` anywhere for execute command line tool | ||
|
|
||
| For uninstall it run `npm unlink` (on unix/mac use `sudo npm unlink`) | ||
|
|
||
| #### 💾 Setup Project | ||
|
|
||
| If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit `setup.json` with correct values and run `npm run setup`. | ||
|
|
||
| #### 🚀 Deploy | ||
|
|
||
| For create npm package: | ||
|
|
||
| - Run `npm run release` | ||
| - Run `npm publish` | ||
|
|
||
| ## 📚 Documentation | ||
|
|
||
| Run `npm run docs` | ||
|
|
@@ -121,7 +133,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d | |
|
|
||
| <!-- all-shields/projects-badges3:START --> | ||
|
|
||
| [](https://github.com/ptkdev-components) [](https://github.com/ptkdev/aboutmeinfo-telegram-bot) [](https://github.com/ptkdev/quizquickanswer-telegram-game-bot) [](https://t.me/gamebookchatbot) [](https://github.com/ptkdev/vscode-theme-dark-blood) [](https://github.com/sourcesense/joyce) | ||
| [](https://github.com/ptkdev-components) [](https://github.com/ptkdev/aboutmeinfo-telegram-bot) [](https://github.com/ptkdev/quizquickanswer-telegram-game-bot) [](https://t.me/gamebookchatbot) [](https://github.com/ptkdev/vscode-theme-dark-blood) | ||
|
|
||
| <!-- all-shields/projects-badges3:END --> | ||
|
|
||
|
|
@@ -137,4 +149,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d | |
| - Images and logos have **CC BY-NC 4.0 License** | ||
| - Documentations and Translations have **CC BY 4.0 License** | ||
|
|
||
| ###### Copyleft (c) 2021 [Patryk Rzucidło](https://ptk.dev) ([@PTKDev](https://twitter.com/ptkdev)) <[[email protected]](mailto:[email protected])> | ||
| ###### Copyleft (c) 2022 [Patryk Rzucidło](https://ptk.dev) ([@PTKDev](https://twitter.com/ptkdev)) <[[email protected]](mailto:[email protected])> | ||
Oops, something went wrong.