it-tools README

The project's README from github.com/CorentinTh/it-tools. As one markdown file: README.md.

logo

Useful tools for developer and people working in IT. Try it!

Functionalities and roadmap

Please check the issues to see if some feature listed to be implemented.

You have an idea of a tool? Submit a feature request!

Self host

Self host solutions for your homelab

From docker hub:

docker run -d --name it-tools --restart unless-stopped -p 8080:80 corentinth/it-tools:latest

From github packages:

docker run -d --name it-tools --restart unless-stopped -p 8080:80 ghcr.io/corentinth/it-tools:latest

Other solutions:

Contribute

VSCode with the following extensions:

with the following settings:

{
  "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) 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 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

pnpm install

Compile and Hot-Reload for Development

pnpm dev

Type-Check, Compile and Minify for Production

pnpm build

Run Unit Tests with Vitest

pnpm test

Lint with ESLint

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:

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!

contributors

Credits

Coded with ❤️ by Corentin Thomasset.

This project is continuously deployed using vercel.com.

Contributor graph is generated using contrib.rocks.

IT Tools - Collection of handy online tools for devs, with great UX | Product Hunt IT Tools - Collection of handy online tools for devs, with great UX | Product Hunt

License

This project is under the GNU GPLv3.

it-tools (CorentinTh/it-tools)

Searching Database…

40.9K ·GitHub
It-tools
What is this?It-tools is a free, open-source collection of handy online tools for developers and people working in IT — small utilities with great UX, gathered in one web app.
So it's a website rather than something I install?It's a web app built with Vue 3 and TypeScript — you use the tools in the browser. The only optional install is self-hosting it in your own homelab via Docker.
How do I get it running for myself?Open the hosted site, or self-host it: prebuilt images come from Docker Hub or GitHub Packages, with one-click options for Cloudron, Tipi and Unraid. For local development, npm run dev launches a Vite server.
Do I need an account, an API key or anything installed to use it?No accounts or API keys — the tools just run in the browser. Self-hosting only needs Docker; developing or building from source needs Node.js with npm.
Anything I should know before self-hosting or building it?Little to worry about: you can run prebuilt images instead of compiling yourself. If you do build the production bundle, the build script raises Node's memory limit to 4 GB.
Do the tools run in my browser, or does my data leave it?It's a static Vue frontend with no backend in the stack, continuously deployed on Vercel — the tools run client-side in your browser.
Is it really free, and what does the license allow?Fully free and open source under GNU GPLv3. It's a copyleft license, so a modified version you distribute has to stay under GPLv3 too.
What kinds of tools are inside?A broad set of small developer utilities, organized by category in the app. The README doesn't enumerate them; the roadmap of what exists and what's planned is tracked in GitHub issues, where you can also request a new tool.
How do I add my own tool to the collection?Run the boilerplate generator script: it creates a directory under src/tools with the right files and adds the import in src/tools/index.ts. Then register the tool in the proper category and implement it.
Is the project actively maintained?Yes — an active project with 40k+ GitHub stars and CI pipelines for releases, nightly Docker images and e2e tests; the hosted deployment is continuously updated through Vercel.
What are similar projects?omni-tools, gin-vue-admin, vuestic-admin, vue-admin-better, hoppscotch, chatgpt-web, dockge, convert
Which topics is it in?developer-productivity, converter, website, tools, vuejs, vue3, homelab, vercel, vite, vue, gplv3, web-app
Creator
CorentinTh
Size
13.4 MB
Stars
40.9K
Updated
CommitFeb 12Releasev2024.10.22-7ca5933Oct 22
Age
6y
Commits · 90 Days