it-tools/README.md

84 lines
3.6 KiB
Markdown
Raw Normal View History

2022-04-13 21:05:55 +00:00
![logo](.github/logo.png)
2022-03-30 22:33:29 +00:00
2022-04-16 13:33:18 +00:00
Useful tools for developer and people working in IT. [Have a look !](https://it-tools.tech).
2022-03-30 22:33:29 +00:00
2022-04-13 21:05:55 +00:00
## Functionalities and roadmap
2022-03-30 22:33:29 +00:00
2022-04-13 21:05:55 +00:00
Please check the [issues](https://github.com/CorentinTh/it-tools/issues) to see if some feature listed to be implemented.
2022-03-30 22:33:29 +00:00
2022-04-13 21:05:55 +00: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-30 22:33:29 +00:00
2022-04-13 21:05:55 +00:00
## Contribute
2022-03-30 22:33:29 +00:00
2022-12-20 19:57:24 +00:00
## Recommended IDE Setup
2022-03-30 22:33:29 +00:00
2022-12-20 19:57:24 +00:00
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
2022-03-30 22:33:29 +00:00
2022-12-20 19:57:24 +00:00
## Type Support for `.vue` Imports in TS
2022-04-16 13:54:39 +00:00
2022-12-20 19:57:24 +00:00
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
2022-04-16 13:54:39 +00:00
2022-12-20 19:57:24 +00:00
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
1. Disable the built-in TypeScript Extension
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
## Customize configuration
2022-12-20 19:57:24 +00:00
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
2022-03-30 22:33:29 +00:00
```sh
2022-12-20 19:57:24 +00:00
pnpm install
2022-03-30 22:33:29 +00:00
```
2022-12-20 19:57:24 +00:00
### Compile and Hot-Reload for Development
2022-03-30 22:33:29 +00:00
```sh
2022-12-20 19:57:24 +00:00
pnpm dev
2022-03-30 22:33:29 +00:00
```
2022-12-20 19:57:24 +00:00
### Type-Check, Compile and Minify for Production
2022-03-30 22:33:29 +00:00
```sh
2022-12-20 19:57:24 +00:00
pnpm build
2022-03-30 22:33:29 +00:00
```
2022-12-20 19:57:24 +00:00
### Run Unit Tests with [Vitest](https://vitest.dev/)
2022-03-30 22:33:29 +00:00
```sh
2022-12-20 19:57:24 +00:00
pnpm test
2022-03-30 22:33:29 +00:00
```
2022-12-20 19:57:24 +00:00
### Lint with [ESLint](https://eslint.org/)
2022-03-30 22:33:29 +00:00
```sh
2022-12-20 19:57:24 +00:00
pnpm lint
2022-03-30 22:33:29 +00:00
```
### Create a new tool
2022-04-16 13:54:39 +00: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-13 21:05:55 +00:00
## Credits
2022-03-30 22:33:29 +00:00
2022-04-13 21:05:55 +00:00
Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).
This project is continuously deployed using [vercel.com](https://vercel.com).
2022-05-11 12:35:45 +00: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-13 21:05:55 +00:00
## License
2022-07-21 19:13:01 +00:00
This project is under the [GNU GPLv3](LICENSE).