From 309ad0386e6ac2d18a8f726e3920cbc72cd913f4 Mon Sep 17 00:00:00 2001 From: daMustermann Date: Sun, 12 Jan 2025 04:16:07 +0100 Subject: [PATCH 1/3] Add README.md with project overview, features, setup instructions, and tech stack --- README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a3ff12 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# Home Inventory Manager 🏠 + +A modern web application for managing your home inventory with an intuitive interface that works in both light and dark modes. Keep track of your items, their locations, and quantities with ease. + +VERY EARLY VERSION + +## Features 🚀 + +- 🌓 Dark/Light mode with system-wide persistence +- 🔍 Real-time search functionality +- 📸 Image upload support +- 📍 Location tracking +- 📊 Quantity management +- ✏️ Edit and update items +- 💾 Automatic SQLite database setup +- 📱 Responsive design +- 🔒 CSRF protection + +## Quick Start 🎯 + +1. Clone the repository: +```bash +git clone https://github.com/yourusername/home-inventory.git +cd home-inventory +``` + +2. Set up Python environment: +```bash +python -m venv venv +venv\Scripts\activate +pip install -r requirements.txt +``` + +3. Run the application: +```bash +python app.py +``` + +4. Open http://localhost:5000 in your browser + +## Tech Stack 💻 + +- **Backend**: Flask + SQLAlchemy +- **Frontend**: Bootstrap 4 + JavaScript +- **Database**: SQLite +- **Security**: Flask-WTF + +## Features in Detail 📋 + +### Item Management +- Add items with images, descriptions, and locations +- Track quantities +- Edit existing items +- Upload item images + +### Search Functionality +- Real-time search across all items +- Search by title, description, or location +- Instant results display + +### Theme Support +- Switch between light and dark modes +- Theme persistence across sessions +- Smooth transition animations + +## Configuration ⚙️ + +Default settings in + +config.py + +: +```python +ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif'} +SQLALCHEMY_DATABASE_URI = 'sqlite:///inventory.db' +``` + +## License 📄 + +MIT License + +--- +Made with ❤️ by daMustermann +``` \ No newline at end of file From 2f231fc1c887b6a58a2d6b4376db1066c4f6da37 Mon Sep 17 00:00:00 2001 From: daMustermann Date: Sun, 12 Jan 2025 04:23:08 +0100 Subject: [PATCH 2/3] Add Docker setup instructions to README.md --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a3ff12..2a27cb5 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,18 @@ python app.py 4. Open http://localhost:5000 in your browser +## Docker Setup 🐳 + +1. Build the Docker image: +```bash +docker build -t inventory-manager . +``` + +2. Run the container: +```bash +docker run -d -p 5000:5000 --name inventory inventory-manager +``` + ## Tech Stack 💻 - **Backend**: Flask + SQLAlchemy @@ -80,5 +92,4 @@ SQLALCHEMY_DATABASE_URI = 'sqlite:///inventory.db' MIT License --- -Made with ❤️ by daMustermann -``` \ No newline at end of file +Made with ❤️ by daMustermann \ No newline at end of file From 018b2a521b84a39b89bf6463690d6697f61b7495 Mon Sep 17 00:00:00 2001 From: daMustermann Date: Sun, 12 Jan 2025 04:24:18 +0100 Subject: [PATCH 3/3] Fix Docker run command in README.md for correct container name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a27cb5..e6d45c9 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ docker build -t inventory-manager . 2. Run the container: ```bash -docker run -d -p 5000:5000 --name inventory inventory-manager +docker run -p 5000:5000 inventory-app ``` ## Tech Stack 💻