Cutlery/it-tools
1
0
Fork 0
mirror of https://github.com/CorentinTh/it-tools.git synced 2025-05-24 02:02:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: added new tool creation procedure

Browse Source
This commit is contained in:
Corentin Thomasset 2022-04-16 15:28:49 +02:00
parent 668625c6da
commit 81778834e6
No known key found for this signature in database
GPG Key ID: DBD997E935996158
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -14,6 +14,12 @@ You have an idea of a tool? Submit a [feature request](https://github.com/Corent
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
### Node version
Ensure you have the correct node/npm version
```sh
nvm use
```
### Project Setup
```sh
@ -44,6 +50,15 @@ npm run test
npm run lint
```
### Create a new tool
To create a new tool, there is a script that generate the boilerplate of the new tool, simply run:
```sh
node scripts/create-tool.mjs my-tool-name
```
It will create a directory in `src/tools` with the correct files, and a the import in `src/tools/index.ts`. You will just need to add the inported tool in the proper category and develop the tool.
## Credits
Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).