https://github.com/open-farms/inventory
Inventory management API for agriculture
https://github.com/open-farms/inventory
agriculture api farms golang grpc
Last synced: about 2 months ago
JSON representation
Inventory management API for agriculture
- Host: GitHub
- URL: https://github.com/open-farms/inventory
- Owner: open-farms
- License: mit
- Created: 2021-11-01T22:48:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-09T06:34:18.000Z (over 4 years ago)
- Last Synced: 2024-06-21T03:14:44.902Z (almost 2 years ago)
- Topics: agriculture, api, farms, golang, grpc
- Language: Go
- Homepage:
- Size: 618 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inventory 📦
> An inventory service for managing farming vehicles, equipment, and resources.
## What is this?
- A REST API for managing farm inventory via HTTP requests
- A gRPC Service for managing farm inventory via RPC requests
- A CLI for managing farm inventory
The inventory service enables users to keep track of farm inventory across multiple IoT devices, servers, applications, or databases. This service provides a foundational interface for inventory management and interaction.
## Structure
```shell
/cmd/inventory # http api server
/cmd/inventoryctl # cli tool for service administration
/ent # database models, migrations, and drivers
/ent/schemas # editable database models
/internal/settings # settings package to read in application configs
```
## Quickstart ⚡
[](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2Fopen-farms%2Finventory&plugins=postgresql&envs=PORT%2CINVENTORY_HTTP_AUTH_ENABLED%2CINVENTORY_HTTP_AUTH_TOKEN&PORTDesc=Exposed+application+port&INVENTORY_HTTP_AUTH_ENABLEDDesc=Enable+basic+auth+for+api&INVENTORY_HTTP_AUTH_TOKENDesc=Token+used+for+basic+authentication&PORTDefault=8000&INVENTORY_HTTP_AUTH_ENABLEDDefault=false&referralCode=XwTg6R)
You can either install inventory directly with go, build the project from source, or [download a binary from the latest release](https://github.com/open-farms/inventory/releases)
### Docker Compose
```shell
# Start the database and API via docker-compose
docker-compose up
# List the vehicles
http :8000/v1/vehicles
```
Install with `go install`
```shell
# Install the server
go install github.com/open-farms/inventory/cmd/inventory@latest
# Install the admin cli
go install github.com/open-farms/inventory/cmd/inventoryctl@latest
```
## Configuration ⚙️
Configure the application with the following environment variables
```shell
# HTTP Settings
INVENTORY_HTTP_ADDR # default:"0.0.0.0:8000"
INVENTORY_HTTP_TIMEOUT # default:"5s"
INVENTORY_HTTP_AUTH_ENABLED # default:"false"
INVENTORY_HTTP_AUTH_TOKEN # default:"inventory" - use "token:inventory" if basic auth enabled with default token
# GRPC Settings
INVENTORY_GRPC_ADDR # default:"0.0.0.0:9000"
INVENTORY_GRPC_TIMEOUT # default:"5s"
# Storage Settings
INVENTORY_STORAGE_DRIVER # default:"postgres"
INVENTORY_STORAGE_URI # default:"" - Automatically configured if deploying to railway
INVENTORY_STORAGE_MIGRATE # default:true
INVENTORY_STORAGE_DEBUG # default:true
```
## Start the service 🏃
Start the service directly with the binary or run it containerized with Docker.
```shell
# Run the inventory service
inventory
```
```shell
# Build the docker image
docker build -t .
# Run the docker image, exposing the service
docker run --rm -v ./config:/data/config -p 8000:8000
```
## Manage the inventory database with the [inventoryctl](./cmd/inventoryctl) CLI
```shell
# Start the postgres database
docker-compose up
# Run the inventoryctl cli to perform database migrations
inventoryctl --help
inventoryctl migrate
```
## Generate code and build from source 🏗️
Generate the service code, openapi spec, and build from source
```
make init
make generate
make test
make build
```
## Services
[View the openapi specification](./openapi.json)
[View the protobuf schemas and services](./ent/proto/entpb/entpb.proto)