Merge pull request #7 from theoleuthardt/readme-update

feat: installation guide updated for docker only
This commit is contained in:
Theo Leuthardt 2025-02-18 11:34:16 +01:00 committed by GitHub
commit c8fd31a372
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,6 +1,6 @@
# Werkzeugkiste # Werkzeugkiste
**Werkzeugkiste** is a Next.js-based website that offers a collection of useful digital tools and converters. **Werkzeugkiste** is a 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 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. files, generate content, or using other handy digital utilities. This page is made by two persons and privacy-focused.
@ -33,30 +33,15 @@ To install and run the project locally, follow these steps:
```bash ```bash
git clone https://github.com/theoleuthardt/werkzeugkiste.git git clone https://github.com/theoleuthardt/werkzeugkiste.git
cd werkzeugkiste cd werkzeugkiste
```
2. **Install the dependencies**:
```bash
npm install
``` ```
3. **Start the website locally with npm**: 2. **Start the website with docker compose**:
```bash
npm run start
```
**or**
3. **Start the website with docker compose**:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. 3. **Open** [http://localhost:3000](http://localhost:3000) in your browser to see the website.
## Authors ## Authors