it-tools/README.md

80 lines
2.7 KiB
Markdown
Raw Normal View History

2022-04-14 05:05:55 +08:00
![logo](.github/logo.png)
2022-03-31 06:33:29 +08:00
2022-04-16 21:33:18 +08:00
Useful tools for developer and people working in IT. [Have a look !](https://it-tools.tech).
2022-03-31 06:33:29 +08:00
2022-04-14 05:05:55 +08:00
## Functionalities and roadmap
2022-03-31 06:33:29 +08:00
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.
2022-03-31 06:33:29 +08:00
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=)!
2022-03-31 06:33:29 +08:00
2022-04-14 05:05:55 +08:00
## Contribute
2022-03-31 06:33:29 +08:00
2022-04-14 05:05:55 +08:00
### Recommended IDE Setup
2022-03-31 06:33:29 +08:00
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).
2022-03-31 06:33:29 +08:00
### Node version
2022-04-16 21:54:39 +08:00
Ensure you have the correct node/npm version
2022-04-16 21:54:39 +08:00
```sh
nvm use
```
2022-04-14 05:05:55 +08:00
### Project Setup
2022-03-31 06:33:29 +08:00
```sh
npm install
```
2022-04-14 05:05:55 +08:00
#### Compile and Hot-Reload for Development
2022-03-31 06:33:29 +08:00
```sh
npm run dev
```
2022-04-14 05:05:55 +08:00
#### Type-Check, Compile and Minify for Production
2022-03-31 06:33:29 +08:00
```sh
npm run build
```
2022-04-14 05:05:55 +08:00
#### Run Unit Tests with [Vitest](https://vitest.dev/)
2022-03-31 06:33:29 +08:00
```sh
2022-04-14 05:05:55 +08:00
npm run test
2022-03-31 06:33:29 +08:00
```
2022-04-14 05:05:55 +08:00
#### Lint with [ESLint](https://eslint.org/)
2022-03-31 06:33:29 +08:00
```sh
2022-04-14 05:05:55 +08:00
npm run lint
2022-03-31 06:33:29 +08:00
```
### Create a new tool
2022-04-16 21:54:39 +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.
2022-04-14 05:05:55 +08:00
## Credits
2022-03-31 06:33:29 +08:00
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).
2022-05-11 20:35:45 +08:00
<a href="https://www.producthunt.com/posts/it-tools?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-it&#0045;tools" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=345793&theme=light" alt="IT&#0032;Tools - Collection&#0032;of&#0032;handy&#0032;online&#0032;tools&#0032;for&#0032;devs&#0044;&#0032;with&#0032;great&#0032;UX | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
<a href="https://www.producthunt.com/posts/it-tools?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-it&#0045;tools" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=345793&theme=light&period=daily" alt="IT&#0032;Tools - Collection&#0032;of&#0032;handy&#0032;online&#0032;tools&#0032;for&#0032;devs&#0044;&#0032;with&#0032;great&#0032;UX | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
2022-04-14 05:05:55 +08:00
## License
2022-07-22 03:13:01 +08:00
This project is under the [GNU GPLv3](LICENSE).