hiro

module
v0.1.5 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2022 License: MIT

README

Hiro

Model Rocket Hiro Project

This project is used by Model Rocket client projects to provide a common foundation for custom platforms.

hiro is not meant to be used as a standalone project.

Developing with the project requires go 1.14 or greater.

Project Layout

This project follows the Standard go Project Layout

~~~
├── api/                        // API definitions
|   └── proto                   // gRPC protocol definitions
|   └── swagger                 // Swagger/OpenAPI 2.0 definitions
├── cmd/                        // Project executables
|   └── hiro/                   // The hiro tool
├── db/                         // The default database components
|   └── sql /                   // Postgres SQL scripts
├── pkg/                        // Library packages
|   └── hiro/                   // The hiro platform
|   └── pb/                     // The hiro protocol buffers platform
├── LICENSE                     // The project license
├── Makefile                    // The project Makefile

~~~

Pre-requisites

All projects based on hiro require postgres12+.

Core Components

The core hiro platform components are:

  1. api - API Services Library for simplifying REST APIs, authorizations, etc.
  2. oauth - OAuth 2.0 library for
  3. hiro - The Hiro Platform for managing apis, applications, users, and more.

Hiro Tool

The hiro tool provides command line support to running instances of hiro applications. More details are in its README.md.

Directories

Path Synopsis
api
cmd
pkg
api
Package api is the hiro api helper library
Package api is the hiro api helper library
env
hiro
Package hiro is a foundational component for Model Rocket platform API services
Package hiro is a foundational component for Model Rocket platform API services
null
Package null provides some clean helpers for sql NULL value handling
Package null provides some clean helpers for sql NULL value handling
oauth
Package oauth provides the base auth interfaces
Package oauth provides the base auth interfaces
ptr
Package ptr provides a set of SQL compatible pointer helpers
Package ptr provides a set of SQL compatible pointer helpers
safe
Package safe returns a safe scalar value from a possible nil pointer
Package safe returns a safe scalar value from a possible nil pointer

Jump to

Keyboard shortcuts

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