mirror of
https://github.com/theoleuthardt/werkzeugkiste.git
synced 2026-06-13 09:37:53 +00:00
64 lines
2 KiB
Markdown
64 lines
2 KiB
Markdown
# Werkzeugkiste
|
|
|
|
**Werkzeugkiste** is a Next.js-based website that offers a collection of useful digital tools and converters.
|
|
This platform is designed to provide users with a simple and efficient way to handle various tasks, such as converting
|
|
files, generate content, or using other handy digital utilities. This page is made by two persons and privacy-focused.
|
|
|
|
## Tech-Stack
|
|
|
|
- **Next.js**: React framework for our frontend with server-side rendering and static content.
|
|
- **React**: JavaScript library for building our user interfaces.
|
|
- **TypeScript**: Typed JavaScript superset for improved code quality.
|
|
- **Tailwind CSS**: Utility-first CSS framework for styling.
|
|
- **Fastify**: Low overhead NodeJS framework for our backend.
|
|
- **Docker**: Containerization platform for deploying frontend and backend.
|
|
|
|
## Implemented Tools
|
|
|
|
- **doc-converter**: Convert documents between different formats.
|
|
- **img-converter**: Convert images between different formats.
|
|
- **rgb-to-hex**: Convert colors between different formats.
|
|
- **data-visualizer**: Visualize your data from table to chart.
|
|
- **qr-code-generator**: Generate QR codes for URLs, text, or other data.
|
|
- **password-generator**: Generate secure passwords.
|
|
- **bg-remover**: Remove backgrounds from your images.
|
|
- **word-counter**: Count words of your documents.
|
|
- **pomodoro-timer**: Use the Pomodoro technique to manage time.
|
|
|
|
## Installation
|
|
|
|
To install and run the project locally, follow these steps:
|
|
|
|
1. **Clone the repository**:
|
|
```bash
|
|
git clone https://github.com/theoleuthardt/werkzeugkiste.git
|
|
cd werkzeugkiste
|
|
|
|
```
|
|
2. **Install the dependencies**:
|
|
|
|
```bash
|
|
npm install
|
|
|
|
```
|
|
|
|
3. **Start the website locally with npm**:
|
|
```bash
|
|
npm run start
|
|
```
|
|
|
|
**or**
|
|
|
|
3. **Start the website with docker compose**:
|
|
|
|
```bash
|
|
docker compose up -d
|
|
|
|
```
|
|
|
|
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
|
|
|
## Authors
|
|
|
|
- [@Domenik Wilhelm](https://www.github.com/AuriomTex)
|
|
- [@Theo Leuthardt](https://www.github.com/theoleuthardt)
|