initial commit

README.md

@@ -0,0 +1,53 @@
+# 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, calculating values, or using other handy digital utilities.
+
+## Tech-Stack
+
+- **Next.js**: React framework for server-side rendering and static websites.
+- **React**: JavaScript library for building user interfaces.
+- **TypeScript**: Typed JavaScript superset for improved code quality.
+- **Tailwind CSS**: Utility-first CSS framework for styling.
+- **Docker**: Containerization platform for deployment.
+
+## Implemented Tools
+
+- **File Converter**: Convert files between different formats.
+- **Image Converter**: Convert images between different formats.
+- **Color Converter**: Convert colors between different formats.
+- **Password Generator**: Generate secure passwords.
+- **Pomodoro Timer**: Use the Pomodoro technique to manage time.
+- **QR Code Generator**: Generate QR codes for URLs, text, or other data.
+
+## 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)