chore: contribute section

This commit is contained in:
ShareVB committed 2025-09-21 12:43:58 +02:00
1 parent bfb4a45d9c
commit 1236082735
1 file changed
+50 -49
+50 -49
View File
@@ -183,55 +183,6 @@ Assuming you're already hosting it-tools behind a reverse proxy, you can configu
(thanks @jogerj)
## Installation methods
Local installation required installing first: `python3 make g++`
| Docker Image | Local Installation |
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| GitHub Container Registry: <span title="triple click me!">`ghcr.io/sharevb/it-tools:latest`</span><br/>Docker Hub: <span title="triple click me!">`sharevb/it-tools:latest`</span> | <span title="triple click me!">`sudo apt-get install python3 make g++ && git clone -b chore/all-my-stuffs https://github.com/sharevb/it-tools.git && cd it-tools/ && pnpm i && pnpm dev`</span> |
| replace your current image with this image | copy & paste oneliner (from github repo) |
| You may need to clear cache and hard reload to get new features loading | Installing packages for the first time may take some time; please wait until it finishes |
<picture>
<source srcset="./.github/logo-dark.png" media="(prefers-color-scheme: light)">
<source srcset="./.github/logo-white.png" media="(prefers-color-scheme: dark)">
<img src="./.github/logo-dark.png" alt="logo">
</picture>
<details>
Useful tools for developer and people working in IT. [Have a look !](https://sharevb-it-tools.vercel.app).
## Functionalities and roadmap
Please check the [issues](https://github.com/sharevb/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/sharevb/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:8080 corentinth/it-tools:latest
```
**From github packages:**
```sh
docker run -d --name it-tools --restart unless-stopped -p 8080:8080 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)
- [YunoHost](https://apps.yunohost.org/app/it-tools)
## Contribute
### Recommended IDE Setup
@@ -307,6 +258,56 @@ 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.
## Installation methods
Local installation required installing first: `python3 make g++`
| Docker Image | Local Installation |
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| GitHub Container Registry: <span title="triple click me!">`ghcr.io/sharevb/it-tools:latest`</span><br/>Docker Hub: <span title="triple click me!">`sharevb/it-tools:latest`</span> | <span title="triple click me!">`sudo apt-get install python3 make g++ && git clone -b chore/all-my-stuffs https://github.com/sharevb/it-tools.git && cd it-tools/ && pnpm i && pnpm dev`</span> |
| replace your current image with this image | copy & paste oneliner (from github repo) |
| You may need to clear cache and hard reload to get new features loading | Installing packages for the first time may take some time; please wait until it finishes |
<picture>
<source srcset="./.github/logo-dark.png" media="(prefers-color-scheme: light)">
<source srcset="./.github/logo-white.png" media="(prefers-color-scheme: dark)">
<img src="./.github/logo-dark.png" alt="logo">
</picture>
<details>
Useful tools for developer and people working in IT. [Have a look !](https://sharevb-it-tools.vercel.app).
## Functionalities and roadmap
Please check the [issues](https://github.com/sharevb/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/sharevb/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:8080 corentinth/it-tools:latest
```
**From github packages:**
```sh
docker run -d --name it-tools --restart unless-stopped -p 8080:8080 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)
- [YunoHost](https://apps.yunohost.org/app/it-tools)
## Contributors
Big thanks to all the people who have already contributed!