mirror of
https://github.com/iib0011/omni-tools.git
synced 2025-09-18 21:49:31 +02:00
167 lines
4.0 KiB
Markdown
167 lines
4.0 KiB
Markdown
<div align="center">
|
|
<img src="src/assets/logo.png" width="300" />
|
|
<br /><br />
|
|
<a href="https://trendshift.io/repositories/13055" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13055" alt="iib0011%2Fomni-tools | Trendshift" style="width: 200px;" width="200"/></a>
|
|
<br /><br />
|
|
<a href="https://github.com/iib0011/omni-tools/releases">
|
|
<img src="https://img.shields.io/badge/version-0.2.0-blue?style=for-the-badge" />
|
|
</a>
|
|
<a href="https://hub.docker.com/r/iib0011/omni-tools">
|
|
<img src="https://img.shields.io/docker/pulls/iib0011/omni-tools?style=for-the-badge&logo=docker" />
|
|
</a>
|
|
<a href="https://github.com/iib0011">
|
|
<img src="https://img.shields.io/github/stars/iib0011/omni-tools?style=for-the-badge&logo=github" />
|
|
</a>
|
|
<a href="https://github.com/iib0011/omni-tools/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/github/license/iib0011/omni-tools?style=for-the-badge" />
|
|
</a>
|
|
<a href="https://discord.gg/SDbbn3hT4b">
|
|
<img src="https://img.shields.io/discord/1342971141823664179?label=Discord&style=for-the-badge" />
|
|
</a>
|
|
<br /><br />
|
|
</div>
|
|
|
|
Welcome to OmniTools, a self-hosted web app offering a variety of online tools to simplify everyday tasks.
|
|
Whether you are coding, manipulating images/videos, PDFs or crunching numbers, OmniTools has you covered. Please don't
|
|
forget to
|
|
star the repo to support us.
|
|
Here is the [demo](https://omnitools.app) website.
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
- [Features](#features)
|
|
- [Self-host](#self-hostrun)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
- [Contact](#contact)
|
|
|
|
## Features
|
|
|
|
We strive to offer a variety of tools, including:
|
|
|
|
## **Image/Video/Binary Tools**
|
|
|
|
- Image Resizer
|
|
- Image Converter
|
|
- Video Trimmer
|
|
- Video Reverser
|
|
- And more...
|
|
|
|
## **String/List Tools**
|
|
|
|
- Case Converters
|
|
- List Shuffler
|
|
- Text Formatters
|
|
- And more...
|
|
|
|
## **Date and Time Tools**
|
|
|
|
- Date Calculators
|
|
- Time Zone Converters
|
|
- And more...
|
|
|
|
## **Math Tools**
|
|
|
|
- Generate Prime Numbers
|
|
- Generate Perfect Numbers
|
|
- And more...
|
|
|
|
## **Miscellaneous Tools**
|
|
|
|
- JSON Tools
|
|
- PDF Tools
|
|
- CSV Tools
|
|
- And more...
|
|
|
|
Stay tuned as we continue to expand and improve our collection!
|
|
|
|
## Self-host/Run
|
|
|
|
### Docker
|
|
|
|
```bash
|
|
docker run -d --name omni-tools --restart unless-stopped -p 8080:80 iib0011/omni-tools:latest
|
|
```
|
|
|
|
### Docker Compose
|
|
|
|
```yaml
|
|
services:
|
|
omni-tools:
|
|
image: iib0011/omni-tools:latest
|
|
container_name: omni-tools
|
|
restart: unless-stopped
|
|
ports:
|
|
- "8080:80"
|
|
|
|
```
|
|
|
|
## Contribute
|
|
|
|
This is a React Project with Typescript Material UI. We use icons from [Iconify](https://icon-sets.iconify.design)
|
|
|
|
### Project setup
|
|
|
|
```bash
|
|
git clone https://github.com/iib0011/omni-tools.git
|
|
cd omni-tools
|
|
npm i
|
|
npm run dev
|
|
```
|
|
|
|
### Create a new tool
|
|
|
|
```bash
|
|
npm run script:create:tool my-tool-name folder1 # npm run script:create:tool split pdf
|
|
```
|
|
|
|
For tools located under multiple nested directories, use:
|
|
|
|
```bash
|
|
npm run script:create:tool my-tool-name folder1/folder2 # npm run script:create:tool compress image/png
|
|
```
|
|
|
|
Use `folder1\folder2` on Windows.
|
|
|
|
### Run tests
|
|
|
|
```bash
|
|
npm run test
|
|
```
|
|
|
|
- For e2e tests
|
|
|
|
```bash
|
|
npm run test:e2e
|
|
```
|
|
|
|
<img src="https://api.star-history.com/svg?repos=iib0011/omni-tools&type=Date"/>
|
|
|
|
## 🤝 Looking to contribute?
|
|
|
|
We welcome contributions! You can help by:
|
|
|
|
- ✅ Reporting bugs
|
|
- ✅ Suggesting new features in Github issues or [here](https://tally.so/r/nrkkx2)
|
|
- ✅ Improving documentation
|
|
- ✅ Submitting pull requests
|
|
|
|
You can also join our [Discord server](https://discord.gg/SDbbn3hT4b)
|
|
|
|
### Contributors
|
|
|
|
<a href="https://github.com/iib0011/omni-tools/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=iib0011/omni-tools" />
|
|
</a>
|
|
|
|
## Contact
|
|
|
|
For any questions or suggestions, feel free to open an issue or contact me at:
|
|
[ibracool99@gmail.com](mailto:ibracool99@gmail.com)
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|