it-tools/README.md

56 lines
1.3 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-14 05:05:55 +08:00
Aggregated set of useful tools that every developer may need once in a while. Available [here](https://dev.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
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
```
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).
## License
This project is under the [MIT license](LICENSE).