Apillon Simplet Blueprint Template 🌐

📚 Overview

This project is a template for creating new Tangle Blueprints using the Apillon Simplet framework. It provides a starting point for creating new projects that can be deployed to the Tangle network. Apillon services and simplets are containerized services that can be deployed and hosted by Tangle operators, leveraging Apillon's SDK and suite of developer tooling for building web3 applications and infrastructures.

Check out Apillon to learn more about the Apillon Simplet framework and how to build and deploy Tangle Blueprints.

📚 Prerequisites

Before you can run this project, you will need to have the following software installed on your machine:

• Rust
• Docker
• Forge
• Tangle

You will also need to install 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)

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/tangle-network/gadget/releases/download/cargo-tangle-v0.1.2/cargo-tangle-installer.sh | sh

Or, if you prefer to install the CLI from crates.io:

cargo install cargo-tangle --force # to get the latest version.

🚀 Getting Started

Once cargo-tangle is installed, you can create a new project with this template with the following command:

cargo tangle blueprint create --name <project-name> --repo <this-repo>

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:

cargo build

to build the project, and

cargo tangle blueprint deploy

to deploy the blueprint to the Tangle network.

📜 License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (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.

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.