warehouse

command module
v0.0.0-...-cbab839 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2021 License: MIT Imports: 18 Imported by: 0

README

warehouse

Version PkgGoDev License Go version

Warehouse is an inventory manager written in Go and served as a web page. It is being built to keep track of product, equipment and orders on a small scale.

How does it work?

By default, warehouse will run a web server at localhost:8080 and create a directory at $HOME/.warehouse to store the information of each sub type.

You can change the port and directory by passing:

$ warehouse -p 5005 -d /path/to/warehouse/dir

localhost:8080 shows a table with the list of items in the inventory. You can press + Add item to add a new item to the inventory using the web interface or manually create an entry at $HOME/.inventory.

Items

Each item is added to its own directory with a unique id name and consist of a info.yaml metadata file, picture.jpg with a picture of the item, and location.jpg with a photo of the return location.

Once the item is added, it will appear inside the table at the root url. Clicking on the thumbnail of the item will open a new page with a QR code linking that specific item. You can print this QR code and physically attach it to the item.

Check in/out with QR codes

Scanning the QR code will open an update item interface where the user is prompted to write their name. Clicking on Use item! will change the state of the item to in use = true and show the name of the person using the item.

After finishing using the item, scan the QR code again to return the item. This time, the user is prompted to upload a photo of the place the item was returned at. Pressing on Return item! will change the state of the item to in use = false and the location of the item can be reviewed by clicking on the returned link from the main inventory url.

Security

Future improvement will be to support local users with authentication.

Note This will block the access to the warehouse main pages, but the QR scan can will still need to be accessed by anyone.

Installation

You can download the release binaries or compile it from source by running:

$ go get -v github.com/medoix/warehouse

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL