homebox/README.md
2022-09-14 09:45:23 -08:00

2.2 KiB

HomeBox

Docs | Demo | Discord

Quick Start

version: "3.4"
 services:
   homebox:
     image: ghcr.io/hay-kot/homebox:nightly
     container_name: homebox
     restart: always
     volumes:
       - homebox-data:/data/
     ports:
       - 3100:7745

volumes:
   homebox-data:
     driver: local

MVP Todo

  • Asset Attachments for Items
  • Db Migrations
    • How To
  • Documentation
    • Docker Compose
    • Config Options
  • Locations
    • Create
    • Update
    • Delete
  • Labels
    • Create
    • Update
    • Delete
  • Items CRUD
    • Create
    • Update
    • Delete
  • Fields To Add
    • Quantity
    • Insured (bool)
  • Bulk Import via CSV
    • Initial
    • Add Warranty Columns
    • All Fields
    • Documentations
  • Release Flow
    • CI/CD Docker Builds w/ Multi-arch
    • Auto Fly.io Deploy for Nightly
    • Deploy Docs
  • Repo House Keeping
    • Add License
    • Issues Template
    • PR Templates
    • Security Policy
    • Feature Request Template
  • Embedded Version Info
    • Version Number
    • Git Hash
  • Setup Docker Volumes in Dockerfile
  • Warranty Information
    • Option for Lifetime Warranty or Warranty Period

All Todo's

  • Dev Container for Development
  • User Invitation Links to Join Group
  • Maintenance Logs
    • Schedule Future Maintenance
    • Email on Maintenance Due
    • QR Code Stickers to Scan to enter a Maintenance Task
  • Export CSV (With IDs)
  • User Profile
    • Adjust Theme (Daisy UI)
    • Delete Profile
    • Send User Invites
    • Set Currency
    • Change Password
  • Admin Page
    • Instance Statistics
    • User Management
      • Delete User
      • Reset Password
  • Expose Swagger API Documentation
    • Dynamic Port / Host Settings

Credits