https://github.com/nanobus/nanobus
NanoBus is a lightweight framework for building secure and scalable software services.
https://github.com/nanobus/nanobus
api-first clean-architecture dapr microservices pipelines postgresql wasm webassembly
Last synced: 11 months ago
JSON representation
NanoBus is a lightweight framework for building secure and scalable software services.
- Host: GitHub
- URL: https://github.com/nanobus/nanobus
- Owner: nanobus
- License: mpl-2.0
- Created: 2021-07-31T21:44:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-25T15:51:11.000Z (almost 3 years ago)
- Last Synced: 2025-03-17T13:16:19.435Z (11 months ago)
- Topics: api-first, clean-architecture, dapr, microservices, pipelines, postgresql, wasm, webassembly
- Language: Go
- Homepage:
- Size: 7.45 MB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
NanoBus is a lightweight framework for building secure and scalable software services.
For detailed information see the [overview](https://nanobus.io/overview) and [architecture](https://nanobus.io/architecture) pages.
## Install
**Linux** - Install from Terminal to `/usr/local/bin`:
```shell
wget -q https://nanobus.io/install.sh -O - | /bin/bash
```
**MacOS** - Install from Terminal to `/usr/local/bin`:
```shell
curl -fsSL https://nanobus.io/install.sh | /bin/bash
```
**Windows** - Install from Command Prompt:
```shell
powershell -Command "iwr -useb https://nanobus.io/install.ps1 | iex"
```
> **Note**: Updates to PATH might not be visible until you restart your terminal application.
**Manually** - Select your architecture from [releases](https://github.com/nanobus/nanobus/releases).
## Create a simple application
Create a file called `bus.yaml` with the following contents:
```yaml
id: hello-world
version: 0.0.1
interfaces:
Greeter:
sayHello:
steps:
- name: Return greeting message
# expr will evaluate a value and assign it
# to the output of this pipeline.
uses: expr
with:
# $ or pipe represent the input data
# for this step.
value: '"Hello, " + $.name'
```
Then run this command from your terminal:
```shell
echo '{"name": "World!"}' | nanobus invoke bus.yaml Greeter::sayHello
```
This should return `Hello, World!` as a JSON string. The JSON data returned by NanoBus applications can be piped to other utilities such as [jq](https://stedolan.github.io/jq/).
## Tutorials and examples
[Getting started](https://nanobus.io/getting-started)
[Basic web service](https://github.com/nanobus/examples/tree/main/basic-web-service)
[WebAssembly-powered web service](https://github.com/nanobus/examples/tree/main/wasm-web-service)
[Dapr integration](https://github.com/nanobus/examples/tree/main/dapr)
[Blog](https://github.com/nanobus/examples/tree/main/blog)
[URL Shortener](https://github.com/nanobus/examples/tree/main/urlshortener)
[NanoChat](https://github.com/nanobus/examples/tree/main/nanochat)
## Community support
For additional help, you can use one of these channels to ask a question:
- [GitHub](https://github.com/nanobus/nanobus/issues) - For bug reports and feature requests.
- [Twitter](https://twitter.com/nanobusdev) - Get the product updates easily.
## Developer setup
### Dependencies
To setup a local development environment
| Dependency | Check | Description |
|:---------- |:---------------- |:--------------------------------------------- |
| [go] | $ go version | Go compiler. Ensure $HOME/go/bin is in PATH. |
| [just] | $ just --version | Like Makefile [just] runs the needed commands |
### Install from source
```shell
git clone https://github.com/nanobus/nanobus.git
cd nanobus
just install
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the code of conduct and the process for submitting pull requests.
## License
This project is licensed under the [Mozilla Public License Version 2.0](https://mozilla.org/MPL/2.0/).
[apex]: https://apexlang.io/docs/getting-started
[apexlang.io]: https://apexlang.io
[docker]: https://docs.docker.com/engine/install/
[docker-compose]: https://docs.docker.com/compose/install/
[go]: https://go.dev/doc/install
[iota]: https://github.com/nanobus/iota
[iotas]: https://github.com/nanobus/iota
[just]: https://github.com/casey/just#Installation
[nanobus]: https://github.com/nanobus/nanobus#Install
[npm]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
[npx]: https://www.npmjs.com/package/npx#Install
[postgres]: https://www.postgresql.org/download/
[postgresql database]: https://www.postgresql.org/
[rust]: https://rustup.rs/