homebox/README.md

<div align="center">
  <img src="/docs/docs/assets/img/lilbox.svg" height="200"/>
</div>

<h1 align="center" style="margin-top: -10px"> HomeBox </h1>
<p align="center" style="width: 100;">
   <a href="https://hay-kot.github.io/homebox/">Docs</a>
   |
   <a href="https://homebox.fly.dev">Demo</a>
   |
   <a href="https://discord.gg/tuncmNrE4z">Discord</a>
</p>

## Quick Start

```yml
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
- [x] Documentation
  - [x] Docker Compose
  - [x] Config Options
- [x] Locations
  - [x] Create
  - [x] Update
  - [x] Delete
- [x] Labels
  - [x] Create
  - [x] Update
  - [x] Delete
- [x] Items CRUD
  - [x] Create
  - [x] Update
  - [x] Delete
- [x] Fields To Add
  - [x] Quantity
  - [x] Insured (bool)
- [x] Bulk Import via CSV
  - [x] Initial
  - [x] Add Warranty Columns
  - [x] All Fields
  - [x] Documentations
- [x] Release Flow
  - [x] CI/CD Docker Builds w/ Multi-arch
  - [x] Auto Fly.io Deploy for Nightly
  - [x] Deploy Docs
- [x] Repo House Keeping
  - [x] Add License
  - [x] Issues Template
  - [x] PR Templates
  - [x] Security Policy
  - [x] Feature Request Template
- [x] Embedded Version Info
  - [x] Version Number
  - [x] Git Hash
- [x] Setup Docker Volumes in Dockerfile
- [x] Warranty Information
  - [x] 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

- Logo by [@lakotelman](https://github.com/lakotelman)
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`<div align="center">`
type img tag 2022-09-14 17:45:23 +00:00			`<img src="/docs/docs/assets/img/lilbox.svg" height="200"/>`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`</div>`
update readme 2022-09-14 17:43:55 +00:00
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`<h1 align="center" style="margin-top: -10px"> HomeBox </h1>`
			`<p align="center" style="width: 100;">`
			`<a href="https://hay-kot.github.io/homebox/">Docs</a>`
			`\|`
			`<a href="https://homebox.fly.dev">Demo</a>`
			`\|`
			`<a href="https://discord.gg/tuncmNrE4z">Discord</a>`
Initial commit 2022-08-30 02:30:36 +00:00			`</p>`
update imports 2022-08-30 02:40:54 +00:00
update docs 2022-09-14 17:35:23 +00:00			`## Quick Start`

			```yml
			`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`
			```

update todo list 2022-09-06 19:37:53 +00:00			`## MVP Todo`

update todos 2022-09-14 05:17:13 +00:00			`- [ ] Asset Attachments for Items`
			`- [ ] Db Migrations`
			`- [ ] How To`
update docs 2022-09-14 17:35:23 +00:00			`- [x] Documentation`
			`- [x] Docker Compose`
			`- [x] Config Options`
update todo list 2022-09-06 19:37:53 +00:00			`- [x] Locations`
			`- [x] Create`
			`- [x] Update`
			`- [x] Delete`
			`- [x] Labels`
			`- [x] Create`
			`- [x] Update`
			`- [x] Delete`
fix: csv-importer (#10) * update item fields to support import_ref * add additional rows to CSV importer * add CSV import documentation * update readme * update readme * fix failed test 2022-09-13 04:54:30 +00:00			`- [x] Items CRUD`
update todo list 2022-09-06 19:37:53 +00:00			`- [x] Create`
fix: csv-importer (#10) * update item fields to support import_ref * add additional rows to CSV importer * add CSV import documentation * update readme * update readme * fix failed test 2022-09-13 04:54:30 +00:00			`- [x] Update`
ui cleanup 2022-09-09 06:05:23 +00:00			`- [x] Delete`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`- [x] Fields To Add`
			`- [x] Quantity`
			`- [x] Insured (bool)`
fix: csv-importer (#10) * update item fields to support import_ref * add additional rows to CSV importer * add CSV import documentation * update readme * update readme * fix failed test 2022-09-13 04:54:30 +00:00			`- [x] Bulk Import via CSV`
updates 2022-09-09 18:20:38 +00:00			`- [x] Initial`
fix: csv-importer (#10) * update item fields to support import_ref * add additional rows to CSV importer * add CSV import documentation * update readme * update readme * fix failed test 2022-09-13 04:54:30 +00:00			`- [x] Add Warranty Columns`
			`- [x] All Fields`
			`- [x] Documentations`
ui cleanup 2022-09-09 06:05:23 +00:00			`- [x] Release Flow`
			`- [x] CI/CD Docker Builds w/ Multi-arch`
init docs 2022-09-09 20:57:44 +00:00			`- [x] Auto Fly.io Deploy for Nightly`
update todo's 2022-09-09 21:02:23 +00:00			`- [x] Deploy Docs`
update todos 2022-09-14 05:17:13 +00:00			`- [x] Repo House Keeping`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`- [x] Add License`
update status 2022-09-14 05:16:00 +00:00			`- [x] Issues Template`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`- [x] PR Templates`
			`- [x] Security Policy`
update status 2022-09-14 05:16:00 +00:00			`- [x] Feature Request Template`
setup docker volumes & versions 2022-09-14 05:15:01 +00:00			`- [x] Embedded Version Info`
			`- [x] Version Number`
			`- [x] Git Hash`
			`- [x] Setup Docker Volumes in Dockerfile`
update todos 2022-09-14 17:39:52 +00:00			`- [x] Warranty Information`
			`- [x] Option for Lifetime Warranty or Warranty Period`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00
			`## All Todo's`
update todo list 2022-09-06 19:37:53 +00:00
update todos 2022-09-14 17:39:52 +00:00			`- [ ] Dev Container for Development`
update todo list 2022-09-06 19:37:53 +00:00			`- [ ] User Invitation Links to Join Group`
			`- [ ] Maintenance Logs`
			`- [ ] Schedule Future Maintenance`
			`- [ ] Email on Maintenance Due`
update todos 2022-09-14 17:39:52 +00:00			`- [ ] QR Code Stickers to Scan to enter a Maintenance Task`
update todo list 2022-09-06 19:37:53 +00:00			`- [ ] Export CSV (With IDs)`
			`- [ ] User Profile`
			`- [ ] Adjust Theme (Daisy UI)`
			`- [ ] Delete Profile`
update todos 2022-09-09 21:12:54 +00:00			`- [ ] Send User Invites`
update todo list 2022-09-06 19:37:53 +00:00			`- [ ] Set Currency`
			`- [ ] Change Password`
			`- [ ] Admin Page`
			`- [ ] Instance Statistics`
			`- [ ] User Management`
			`- [ ] Delete User`
			`- [ ] Reset Password`
update todos 2022-09-09 21:12:54 +00:00			`- [ ] Expose Swagger API Documentation`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`- [ ] Dynamic Port / Host Settings`

			`## Credits`
update todos 2022-09-14 05:17:13 +00:00
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 22:47:27 +00:00			`- Logo by [@lakotelman](https://github.com/lakotelman)`