mirror of
https://github.com/CorentinTh/it-tools.git
synced 2024-12-27 02:04:05 +08:00
127 lines
4.7 KiB
Markdown
127 lines
4.7 KiB
Markdown
|
|
|
|
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/choose)!
|
|
|
|
## Self host
|
|
|
|
Self host solutions for your homelab
|
|
|
|
**From docker hub:**
|
|
|
|
```sh
|
|
docker run -d --name it-tools --restart unless-stopped -p 8080:80 corentinth/it-tools:latest
|
|
```
|
|
|
|
**From github packages:**
|
|
|
|
```sh
|
|
docker run -d --name it-tools --restart unless-stopped -p 8080:80 ghcr.io/corentinth/it-tools:latest
|
|
```
|
|
|
|
**Other solutions:**
|
|
|
|
- [Cloudron](https://www.cloudron.io/store/tech.ittools.cloudron.html)
|
|
- [Tipi](https://www.runtipi.io/docs/apps-available)
|
|
- [Unraid](https://unraid.net/community/apps?q=it-tools)
|
|
|
|
## Contribute
|
|
|
|
### Recommended IDE Setup
|
|
|
|
[VSCode](https://code.visualstudio.com/) with the following extensions:
|
|
|
|
- [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).
|
|
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally)
|
|
|
|
with the following settings:
|
|
|
|
```json
|
|
{
|
|
"editor.formatOnSave": false,
|
|
"editor.codeActionsOnSave": {
|
|
"source.fixAll.eslint": true
|
|
},
|
|
"i18n-ally.localesPaths": ["locales", "src/tools/*/locales"],
|
|
"i18n-ally.keystyle": "nested"
|
|
}
|
|
```
|
|
|
|
### Type Support for `.vue` Imports in TS
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
### Project Setup
|
|
|
|
```sh
|
|
pnpm install
|
|
```
|
|
|
|
### Compile and Hot-Reload for Development
|
|
|
|
```sh
|
|
pnpm dev
|
|
```
|
|
|
|
### Type-Check, Compile and Minify for Production
|
|
|
|
```sh
|
|
pnpm build
|
|
```
|
|
|
|
### Run Unit Tests with [Vitest](https://vitest.dev/)
|
|
|
|
```sh
|
|
pnpm test
|
|
```
|
|
|
|
### Lint with [ESLint](https://eslint.org/)
|
|
|
|
```sh
|
|
pnpm 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
|
|
pnpm run script:create:tool 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 imported tool in the proper category and develop the tool.
|
|
|
|
## Contributors
|
|
|
|
Big thanks to all the people who have already contributed!
|
|
|
|
[](https://github.com/corentinth/it-tools/graphs/contributors)
|
|
|
|
## Credits
|
|
|
|
Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).
|
|
|
|
This project is continuously deployed using [vercel.com](https://vercel.com).
|
|
|
|
Contributor graph is generated using [contrib.rocks](https://contrib.rocks/preview?repo=corentinth/it-tools).
|
|
|
|
<a href="https://www.producthunt.com/posts/it-tools?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-it-tools" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=345793&theme=light" alt="IT Tools - Collection of handy online tools for devs, with great 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-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 Tools - Collection of handy online tools for devs, with great UX | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
|
|
|
## License
|
|
|
|
This project is under the [GNU GPLv3](LICENSE).
|