README
¶
tiny
A developer toolkit for building NATS-based microservices in Go.
Overview
tiny provides tools to streamline the development of microservices that use NATS for communication. It offers code generation capabilities from service definitions written in a MuCL (Micro Control Language) format.
Installation
go install github.com/bketelsen/tiny@latest
Quick Start
- Initialize a new project:
tiny init
- Generate the service code:
tiny gen
- Implement your business logic in the generated files
Commands
Generate
Generate code from a MuCL file:
tiny gen --definition <file.tiny> [--types] [--force]
Options:
--types: Generate only type definitions--force: Overwrite existing files
Initialize
Create a new project structure:
tiny init [project-name]
Documentation
Comprehensive documentation is available at the tiny documentation site.
Development
Prerequisites
- Go 1.16 or newer
- Task for development workflows
Build from source
task build
Run tests
task test
Generate documentation
task docs:build
Preview documentation locally:
task docs:preview
Contributing
Contributions are welcome! Please see our Contributing Guide for more details.
License
This project is licensed under the MIT License.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cleanenv gives you a single tool to read application configuration from several sources with ease.
|
Package cleanenv gives you a single tool to read application configuration from several sources with ease. |
|
example/custom_setter
command
|
|
|
example/env_config
command
|
|
|
example/parse_multiple_files
command
|
|
|
example/simple_config
command
|
|
|
Package cmd provides the command line interface for mu
|
Package cmd provides the command line interface for mu |
|
dev
Package dev provides the dev command for running development infrastructure
|
Package dev provides the dev command for running development infrastructure |
|
ebnf
Package gen provides the gen command for generating code from a mucl file
|
Package gen provides the gen command for generating code from a mucl file |
|
gen
Package gen provides the gen command for generating code from a mucl file
|
Package gen provides the gen command for generating code from a mucl file |
|
init
Package init provides the init command for creating a new service
|
Package init provides the init command for creating a new service |
|
Package enats provides an embedded NATS server for testing purposes.
|
Package enats provides an embedded NATS server for testing purposes. |
|
Package mucl provides a parser for the MuCL (Micro Configuration Language) protocol.
|
Package mucl provides a parser for the MuCL (Micro Configuration Language) protocol. |
|
Package project defines a tiny project structure
|
Package project defines a tiny project structure |
|
templates
Package templates provides templates for generating code
|
Package templates provides templates for generating code |
|
Package service provides a wrapper around NATS for microservices.
|
Package service provides a wrapper around NATS for microservices. |
Click to show internal directories.
Click to hide internal directories.