Add mock data for storage locations and products in database.mockEN.sql

- Inserted 5 storage locations including Main Freezer, Kitchen Freezer, Pantry, Kitchen Fridge, and Cellar Shelf. - Added approximately 100 products with details such as name, description, price, amount, storage location, expiry date, bottling date, and picture. - Included both self-frozen items and store-bought items, with appropriate attributes for each.
2026-06-04 13:09:25 +02:00
parent 53efd21a2b
commit 5875a51e94
9 changed files with 248 additions and 45 deletions
@@ -1,2 +1,113 @@
 # StockHome

+![React](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=000&style=flat)
+![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff&style=flat)
+![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=fff&style=flat)
+![Tailwind%20CSS](https://img.shields.io/badge/Tailwind%20CSS-38B2AC?logo=tailwindcss&logoColor=fff&style=flat)
+![MUI](https://img.shields.io/badge/MUI-007FFF?logo=mui&logoColor=fff&style=flat)
+![TanStack%20Query](https://img.shields.io/badge/TanStack%20Query-FF4154?logo=reactquery&logoColor=fff&style=flat)
+![React%20Router](https://img.shields.io/badge/React%20Router-CA4245?logo=reactrouter&logoColor=fff&style=flat)
+[![TanStack%20Form](https://img.shields.io/badge/TanStack%20Form-EC5990?logo=reacthookform&logoColor=fff)](#)
+![Node.js](https://img.shields.io/badge/Node.js-339933?logo=nodedotjs&logoColor=fff&style=flat)
+![Express](https://img.shields.io/badge/Express-000000?logo=express&logoColor=fff&style=flat)
+![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=fff&style=flat)
+![Docker](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff&style=flat)
+![Nginx](https://img.shields.io/badge/Nginx-009639?logo=nginx&logoColor=fff&style=flat)
+
+The problem solver for every home in the world: **STOCKHOME**! Have you ever spent too long searching for things in your freezer or pantry? If so, this open-source project is just the right thing for your home server!
+
+<p align="center">
+  <img src="./.github/assets/Arc_Inventory.low.jpg" width="802" alt="Inventory Screenshot" />
+</p>
+
+## Features
+
+- Organize your food at home
+- Keep track of the Expiry and Bottling date of your food
+- Organzize your food and products into different storages (Storage locations)
+- Rename your app and change the currency
+- Keep track of the stored amount of your food
+- Keep track of the costs for your food
+
+## Installation
+
+### 1. Install Docker
+
+If you haven't installed Docker yet, install it by running as root:
+
+```shell
+curl -sSL https://get.docker.com | sh
+exit
+```
+
+### 2. Clone repository
+
+If you haven't installed git, download the source code from this repository from the release page and unpack the `.zip` file.
+
+**OR**
+
+If you want to be always up to date, you can clone this repository by running:
+
+```shell
+git clone https://git.the1s.de/theis.gaedigk/stockhome.git
+```
+
+> **NOTE**: To do this, you must have git installed. [How to install git?](https://git-scm.com/install/)
+
+### 3. Run Stockhome
+
+First, navigate into the root directory of this repository and run:
+
+```shell
+docker compose up -d --build
+```
+
+The database and all necessary services are started and initialised automatically.
+
+### 4. First login
+
+The default admin credentials are always:
+
+```
+Username: admin
+Password: admin
+```
+
+_Keep in mind that you should change the password later in the settings page._
+
+## Development
+
+### Prerequisites
+
+- Docker
+- Visual Studio Code
+- Cloned the repository
+
+### Start backend and database
+
+First, navigate into the root directory of this repository and run:
+
+```shell
+docker compose -f docker-compose.dev.yml up -d --build
+```
+
+### Start frontend
+
+Navigate into the `frontend` directory and run:
+
+```shell
+npm install
+npm run dev
+```
+
+The frontend is now running on `http://localhost:5173` and the backend is running on `http://localhost:8004`.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+Whole project made by [Theis Gaedigk](https://portfolio-theis.de)!