README
¶
haul
Inventory management system for patchwork components and assets.
prerequisites
To build and deploy the server:
-
docker
-
docker-compose
To build the client:
- go
procedure
Deploy mongodb and haul server
$ docker-compose up -d --build
Make sure the server is up
$ docker-compose logs haul
optional - local cli
Haul is accessed mainly through its API.
Install the cli locally.
$ go install
Then, add a config locally to $HOME/.haul.yaml from the example/haul.yaml, or specify a different config location with the --config flag.
Note that if you installed the server from docker-compose without any modifications, this should be unnecessary to access the server on the same host.
Once that is done, make sure you can access the server with a healthcheck
$ haul ping
You can then list all api routes
$ haul api
See $ haul help for more options
Documentation
¶
Overview ¶
Copyright © 2023 The Haul Authors
Inventory management system for patchwork components and assets.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api implements functions to make http requests, with or without data, of multiple possible methods.
|
Package api implements functions to make http requests, with or without data, of multiple possible methods. |
|
Package cmd implements cobra commands for the application.
|
Package cmd implements cobra commands for the application. |
|
Package db implements database operations for the haul server.
|
Package db implements database operations for the haul server. |
|
Package handlers implements handlers for the labstack/echo/v4 API routes.
|
Package handlers implements handlers for the labstack/echo/v4 API routes. |
|
Package types implements the types and validation of types necessary for the application to function.
|
Package types implements the types and validation of types necessary for the application to function. |