https://github.com/tangle-network/blueprint-template
A simple Hello World Blueprint for Tangle.
https://github.com/tangle-network/blueprint-template
Last synced: 11 months ago
JSON representation
A simple Hello World Blueprint for Tangle.
- Host: GitHub
- URL: https://github.com/tangle-network/blueprint-template
- Owner: tangle-network
- License: apache-2.0
- Created: 2024-07-31T12:28:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-21T23:06:24.000Z (about 1 year ago)
- Last Synced: 2025-01-22T00:18:43.037Z (about 1 year ago)
- Language: Solidity
- Homepage:
- Size: 465 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
#
Hello World Tangle Blueprint 🌐
## 📚 Overview
This Tangle Blueprint provides a simple Hello World job.
Blueprints are specifications for AVSs on the Tangle Network. An AVS is
an off-chain service that runs arbitrary computations for a user-specified period of time.
Blueprints provide a useful abstraction, allowing developers to create reusable service infrastructures as if they were
smart contracts. This enables developers to monetize their work and align long-term incentives with the success of their
creations, benefiting proportionally to their Blueprint's usage.
For more details, please refer to the [project documentation](https://docs.tangle.tools/developers/blueprints/introduction).
## 🚀 Features
- Custom greeting messages
- Default "Hello World!" messages
- ...
## 📋 Prerequisites
Before you can run this project, you will need to have the following software installed on your machine:
- [Rust](https://www.rust-lang.org/tools/install)
- [Forge](https://getfoundry.sh)
You will also need to install [cargo-tangle](https://crates.io/crates/cargo-tangle), our CLI tool for creating and
deploying Tangle Blueprints:
To install the Tangle CLI, run the following command:
> Supported on Linux, MacOS, and Windows (WSL2)
```bash
cargo install cargo-tangle --git https://github.com/tangle-network/blueprint
```
## ⭐ Getting Started
Once `cargo-tangle` is installed, you can create a new project with the following command:
```sh
cargo tangle blueprint create --name
```
and follow the instructions to create a new project.
## 🛠️ Development
Once you have created a new project, you can run the following command to start the project:
```sh
cargo build
```
to build the project, and
```sh
cargo tangle blueprint deploy
```
to deploy the blueprint to the Tangle network.
## 📜 License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## 📬 Feedback and Contributions
We welcome feedback and contributions to improve this blueprint.
Please open an issue or submit a pull request on our GitHub repository.
Please let us know if you fork this blueprint and extend it too!
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.