it-tools/README.md

![logo](.github/logo.png)

Useful tools for developer and people working in IT. [Have a look !](https://it-tools.tech).

## Functionalities and roadmap

Please check the [issues](https://github.com/CorentinTh/it-tools/issues) to see if some feature listed to be implemented.

You have an idea of a tool? Submit a [feature request](https://github.com/CorentinTh/it-tools/issues/new?assignees=corentinth&labels=&template=feature_request.md&title=)!

## Contribute

### Recommended IDE Setup

[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
npm install
```

#### Compile and Hot-Reload for Development

```sh
npm run dev
```

#### Type-Check, Compile and Minify for Production

```sh
npm run build
```

#### Run Unit Tests with [Vitest](https://vitest.dev/)

```sh
npm run test
```

#### Lint with [ESLint](https://eslint.org/)

```sh
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).

This project is continuously deployed using [vercel.com](https://vercel.com).

## License

This project is under the [MIT license](LICENSE).
docs: updated readme 2022-04-14 05:05:55 +08:00			`![logo](.github/logo.png)`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated description 2022-04-16 21:33:18 +08:00			`Useful tools for developer and people working in IT. [Have a look !](https://it-tools.tech).`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`## Functionalities and roadmap`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`Please check the [issues](https://github.com/CorentinTh/it-tools/issues) to see if some feature listed to be implemented.`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`You have an idea of a tool? Submit a [feature request](https://github.com/CorentinTh/it-tools/issues/new?assignees=corentinth&labels=&template=feature_request.md&title=)!`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`## Contribute`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`### Recommended IDE Setup`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`[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).`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: added new tool creation procedure 2022-04-16 21:28:49 +08:00			`### Node version`
chore(style): lint README 2022-04-16 21:54:39 +08:00
docs: added new tool creation procedure 2022-04-16 21:28:49 +08:00			`Ensure you have the correct node/npm version`
chore(style): lint README 2022-04-16 21:54:39 +08:00
docs: added new tool creation procedure 2022-04-16 21:28:49 +08:00			```sh
			`nvm use`
			```

docs: updated readme 2022-04-14 05:05:55 +08:00			`### Project Setup`
chore: first commit 2022-03-31 06:33:29 +08:00
			```sh
			`npm install`
			```

docs: updated readme 2022-04-14 05:05:55 +08:00			`#### Compile and Hot-Reload for Development`
chore: first commit 2022-03-31 06:33:29 +08:00
			```sh
			`npm run dev`
			```

docs: updated readme 2022-04-14 05:05:55 +08:00			`#### Type-Check, Compile and Minify for Production`
chore: first commit 2022-03-31 06:33:29 +08:00
			```sh
			`npm run build`
			```

docs: updated readme 2022-04-14 05:05:55 +08:00			`#### Run Unit Tests with [Vitest](https://vitest.dev/)`
chore: first commit 2022-03-31 06:33:29 +08:00
			```sh
docs: updated readme 2022-04-14 05:05:55 +08:00			`npm run test`
chore: first commit 2022-03-31 06:33:29 +08:00			```

docs: updated readme 2022-04-14 05:05:55 +08:00			`#### Lint with [ESLint](https://eslint.org/)`
chore: first commit 2022-03-31 06:33:29 +08:00
			```sh
docs: updated readme 2022-04-14 05:05:55 +08:00			`npm run lint`
chore: first commit 2022-03-31 06:33:29 +08:00			```

docs: added new tool creation procedure 2022-04-16 21:28:49 +08:00			`### Create a new tool`
chore(style): lint README 2022-04-16 21:54:39 +08:00
docs: added new tool creation procedure 2022-04-16 21:28:49 +08:00			`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.

docs: updated readme 2022-04-14 05:05:55 +08:00			`## Credits`
chore: first commit 2022-03-31 06:33:29 +08:00
docs: updated readme 2022-04-14 05:05:55 +08:00			`Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).`

			`This project is continuously deployed using [vercel.com](https://vercel.com).`

			`## License`

			`This project is under the [MIT license](LICENSE).`