{"id":24843149,"url":"https://github.com/sethbang/whole-home-inventory-system","last_synced_at":"2026-04-12T18:03:07.035Z","repository":{"id":269257953,"uuid":"906875396","full_name":"sethbang/whole-home-inventory-system","owner":"sethbang","description":"whole-home-inventory-system","archived":false,"fork":false,"pushed_at":"2025-01-01T16:02:15.000Z","size":8164,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-17T15:51:42.806Z","etag":null,"topics":["docker","fastapi","file-upload","home-organization","inventory","inventory-management","pwa","python","react","secure-storage","smart-home","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sethbang.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-22T07:02:18.000Z","updated_at":"2025-01-21T14:41:27.000Z","dependencies_parsed_at":"2025-06-17T15:53:36.828Z","dependency_job_id":null,"html_url":"https://github.com/sethbang/whole-home-inventory-system","commit_stats":null,"previous_names":["sethbang/whole-home-inventory-system"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sethbang/whole-home-inventory-system","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethbang%2Fwhole-home-inventory-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethbang%2Fwhole-home-inventory-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethbang%2Fwhole-home-inventory-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethbang%2Fwhole-home-inventory-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sethbang","download_url":"https://codeload.github.com/sethbang/whole-home-inventory-system/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethbang%2Fwhole-home-inventory-system/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265866258,"owners_count":23840937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","fastapi","file-upload","home-organization","inventory","inventory-management","pwa","python","react","secure-storage","smart-home","typescript"],"created_at":"2025-01-31T08:37:33.317Z","updated_at":"2025-10-19T10:29:49.131Z","avatar_url":"https://github.com/sethbang.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"images/whis_logo_web.svg\" alt=\"WHIS Logo\" width=\"256\" height=\"256\"\u003e\n\u003c/div\u003e\n\n# Whole-Home Inventory System (WHIS)\n\nWHIS is a self-hosted platform for managing household inventories. It centralizes item information—descriptions, photos, locations, purchase details, valuations, warranties—into a local database accessible from multiple devices via a web interface.\n\n## Documentation\n\n📚 **[View Full Documentation](#documentation-suite)**\n\n- 📖 [Architecture Overview](ARCHITECTURE.md)\n- 🔧 [Development Guide](DEVELOPMENT.md)\n- 🧪 [Testing Guide](TESTING.md)\n- 🤝 [Contributing Guidelines](CONTRIBUTING.md)\n- 📜 [API Documentation](API.md)\n- 🔒 [Security Policy](SECURITY.md)\n- 📋 [Changelog](CHANGELOG.md)\n- 📦 [Deployment Guide](DEPLOYMENT.md)\n\n## Features\n\n- 📱 **Progressive Web App (PWA)**: Offline access and mobile app-like experience\n- 📸 **Photo Management**: Multiple images per item with camera integration\n- 🔍 **Advanced Search**: Filter and sort by any field\n- 🏷️ **Custom Fields**: Define your own data fields and categories\n- 🔒 **Privacy-Focused**: Self-hosted with local data storage\n- 📱 **Mobile-Optimized**: Camera integration and quick-add functionality\n- 📊 **Analytics \u0026 Reports**: Generate detailed reports about your inventory\n- 🔄 **Backup \u0026 Restore**: Automated backup system with restore capabilities\n- 📷 **Barcode/QR Scanning**: Quick item lookup and entry using barcodes\n- 🔄 **Data Migration**: Import/export functionality for various formats\n\n## Screenshots\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"images/screenshots/WHIS - Whole-Home Inventory System.jpeg\" alt=\"WHIS Dashboard\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eMain Dashboard - Overview of your inventory items\u003c/em\u003e\u003c/p\u003e\n  \n  \u003cimg src=\"images/screenshots/WHIS - Whole-Home Inventory System · 5.08pm · 12-22.jpeg\" alt=\"WHIS Item Details\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eItem Details View - Comprehensive information about each item\u003c/em\u003e\u003c/p\u003e\n  \n  \u003cimg src=\"images/screenshots/WHIS - Whole-Home Inventory System · 5.08pm · 12-22 (1).jpeg\" alt=\"WHIS Add Item\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eAdd Item Form - Easy item entry with custom fields\u003c/em\u003e\u003c/p\u003e\n  \n  \u003cimg src=\"images/screenshots/WHIS - Whole-Home Inventory System · 5.08pm · 12-22 (2).jpeg\" alt=\"WHIS Reports\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eAnalytics Dashboard - Detailed insights about your inventory\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n## Documentation Suite\n\nWHIS provides comprehensive documentation to help you understand, use, and contribute to the project:\n\n### For Users\n\n- **[User Guide](docs/USER_GUIDE.md)**: Complete guide to using WHIS\n- **[Installation Guide](#installation)**: Step-by-step installation instructions\n- **[Deployment Guide](DEPLOYMENT.md)**: Production deployment instructions\n- **[Security Policy](SECURITY.md)**: Security information and best practices\n- **[Changelog](CHANGELOG.md)**: Version history and updates\n\n### For Developers\n\n- **[Architecture Overview](ARCHITECTURE.md)**: System design and technical decisions\n- **[Development Guide](DEVELOPMENT.md)**: Setting up development environment\n- **[Contributing Guidelines](CONTRIBUTING.md)**: How to contribute to WHIS\n- **[Testing Guide](TESTING.md)**: Testing procedures and guidelines\n- **[API Documentation](API.md)**: Complete API reference\n\n## Tech Stack\n\n### Backend\n- Python 3.11\n- FastAPI\n- SQLite\n- Uvicorn\n- Alembic (Database migrations)\n\n### Frontend\n- React 18\n- TypeScript\n- Tailwind CSS\n- Vite\n- PWA Support\n\n## Prerequisites\n\n- Python 3.11 or higher\n- Node.js 16 or higher\n- npm or yarn\n- Git\n\n## Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/yourusername/whole-home-inventory-system.git\ncd whole-home-inventory-system\n```\n\n2. Set up the backend:\n```bash\ncd backend\npython -m venv venv\nsource venv/bin/activate  # On Windows use: venv\\Scripts\\activate\npip install -r requirements.txt\nalembic upgrade head  # Initialize the database\n```\n\n3. Set up the frontend:\n```bash\ncd frontend\nnpm install\n```\n\n## Development Setup\n\n### Certificate Setup (Required)\n\n\u003e ⚠️ **Important**: WHIS uses HTTPS for secure communication. You must set up the development certificates before running the application.\n\n1. Generate the development certificates:\n```bash\ncd frontend\nnode scripts/generate-certs.js\n```\nThis will create:\n- A root Certificate Authority (CA) certificate\n- Server certificates for local development\n- All certificates are stored in the `certs` directory\n\n2. Install the CA certificate on your development machine:\n\n#### macOS:\n```bash\ncd ../certs\nsudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain whis-dev-ca.crt\n```\n\n#### Linux:\n```bash\ncd ../certs\nsudo cp whis-dev-ca.crt /usr/local/share/ca-certificates/\nsudo update-ca-certificates\n```\n\n#### Windows:\n1. Navigate to the `certs` directory\n2. Double-click `whis-dev-ca.crt`\n3. Click \"Install Certificate\"\n4. Select \"Local Machine\"\n5. Choose \"Trusted Root Certification Authorities\"\n6. Complete the installation wizard\n\nFor detailed instructions including mobile devices and NAS setup, see `certs/CERTIFICATE-SETUP.md`.\n\n\u003e 📝 **Note**: The certificate needs to be installed on each device that will access WHIS.\n\n3. Start the backend server:\n```bash\ncd backend\nsource venv/bin/activate  # On Windows use: venv\\Scripts\\activate\nuvicorn app.main:app --reload\n```\n\n4. Start the frontend development server:\n```bash\ncd frontend\nnpm run dev\n```\n\nThe application will be available at:\n- Local development: https://localhost:5173\n- Network access: https://[your-ip]:5173 or https://[your-nas]:5173\n\n## Quick Start Guide\n\n1. **First Time Setup**\n   - Create an admin account using the registration page\n   - Log in to access the dashboard\n\n2. **Adding Items**\n   - Click the \"Add Item\" button\n   - Fill in the item details\n   - Add photos using upload or camera capture\n   - Use barcode scanner for quick entry\n   - Save the item\n\n3. **Managing Items**\n   - Browse items from the dashboard\n   - Use search and filters to find specific items\n   - Click on items to view/edit details\n   - Add custom fields as needed\n\n4. **Data Management**\n    - Create automatic backups of your data\n    - Download backups for safekeeping\n    - Upload backup files to restore data\n    - Import/export data using migration tools\n    - Generate reports and analytics\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on:\n- Code of Conduct\n- Development process\n- Pull request procedure\n- Coding standards\n\n## Support\n\n- 📖 [Documentation](#documentation-suite)\n- 🐛 [Issue Tracker](https://github.com/yourusername/whole-home-inventory-system/issues)\n- 💬 [Discussions](https://github.com/yourusername/whole-home-inventory-system/discussions)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- Built with [FastAPI](https://fastapi.tiangolo.com/)\n- UI powered by [React](https://reactjs.org/)\n- Styled with [Tailwind CSS](https://tailwindcss.com/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsethbang%2Fwhole-home-inventory-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsethbang%2Fwhole-home-inventory-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsethbang%2Fwhole-home-inventory-system/lists"}