-
Notifications
You must be signed in to change notification settings - Fork 547
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into dependabot/npm_and_yarn/docs/postcss-8.4.31
- Loading branch information
Showing
123 changed files
with
17,323 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
docs/versioned_docs/version-v0.27.2/01-welcome/01-index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| slug: / | ||
| --- | ||
|
|
||
| import ProjectsTable from '@site/src/components/ProjectsTable'; | ||
|
|
||
| # Introduction to Ignite | ||
|
|
||
| [Ignite CLI](https://github.com/ignite/cli) offers everything you need to build, test, and launch your blockchain with a | ||
| decentralized worldwide community. Ignite CLI is built on top of [Cosmos SDK](https://docs.cosmos.network), the world’s | ||
| most popular blockchain framework. Ignite CLI accelerates chain development by scaffolding everything you need so you | ||
| can focus on business logic. | ||
|
|
||
| ## What is Ignite CLI? | ||
|
|
||
| Ignite CLI is an easy-to-use CLI tool for creating and maintaining sovereign application-specific blockchains. | ||
| Blockchains created with Ignite CLI use Cosmos SDK and Tendermint. Ignite CLI and the Cosmos SDK modules are written in | ||
| the Go programming language. The scaffolded blockchain that is created with Ignite CLI includes a command line interface | ||
| that lets you manage keys, create validators, and send tokens. | ||
|
|
||
| With just a few commands, you can use Ignite CLI to: | ||
|
|
||
| - Create a modular blockchain written in Go | ||
| - Scaffold modules, messages, types with CRUD operations, IBC packets, and more | ||
| - Start a blockchain node in development with live reloading | ||
| - Connect to other blockchains with a built-in IBC relayer | ||
| - Use generated TypeScript/Vuex clients to interact with your blockchain | ||
| - Use the Vue.js web app template with a set of components and Vuex modules | ||
|
|
||
| ## Install Ignite CLI | ||
|
|
||
| To install the `ignite` binary in `/usr/local/bin` run the following command: | ||
|
|
||
| ``` | ||
| curl https://get.ignite.com/cli | bash | ||
| ``` | ||
|
|
||
| ## Projects using Tendermint and Cosmos SDK | ||
|
|
||
| Many projects already showcase the Tendermint BFT consensus engine and the Cosmos SDK. Explore | ||
| the [Cosmos ecosystem](https://cosmos.network/ecosystem/apps) to discover a wide variety of apps, blockchains, wallets, | ||
| and explorers that are built in the Cosmos ecosystem. | ||
|
|
||
| ## Projects building with Ignite CLI | ||
|
|
||
| <ProjectsTable data={[ | ||
| { name: "Stride Labs", logo: "img/logo/stride.svg"}, | ||
| { name: "KYVE Network", logo: "img/logo/kyve.svg"}, | ||
| { name: "Umee", logo: "img/logo/umee.svg"}, | ||
| { name: "MediBloc Core", logo: "img/logo/medibloc.svg"}, | ||
| { name: "Cudos", logo: "img/logo/cudos.svg"}, | ||
| { name: "Firma Chain", logo: "img/logo/firmachain.svg"}, | ||
| { name: "BitCanna", logo: "img/logo/bitcanna.svg"}, | ||
| { name: "Source Protocol", logo: "img/logo/source.svg"}, | ||
| { name: "Sonr", logo: "img/logo/sonr.svg"}, | ||
| { name: "Neutron", logo: "img/logo/neutron.svg"}, | ||
| { name: "OKP4 Blockchain", logo: "img/logo/okp4.svg"}, | ||
| { name: "Dymension Hub", logo: "img/logo/dymension.svg"}, | ||
| { name: "Electra Blockchain", logo: "img/logo/electra.svg"}, | ||
| { name: "OLLO Station", logo: "img/logo/ollostation.svg"}, | ||
| { name: "Mun", logo: "img/logo/mun.svg"}, | ||
| { name: "Aura Network", logo: "img/logo/aura.svg"}, | ||
| ]}/> |
114 changes: 114 additions & 0 deletions
114
docs/versioned_docs/version-v0.27.2/01-welcome/02-install.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| description: Steps to install Ignite CLI on your local computer. | ||
| --- | ||
|
|
||
| # Install Ignite CLI | ||
|
|
||
| You can run [Ignite CLI](https://github.com/ignite/cli) in a web-based Gitpod IDE or you can install Ignite CLI on your | ||
| local computer. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Be sure you have met the prerequisites before you install and use Ignite CLI. | ||
|
|
||
| ### Operating systems | ||
|
|
||
| Ignite CLI is supported for the following operating systems: | ||
|
|
||
| - GNU/Linux | ||
| - macOS | ||
| - Windows Subsystem for Linux (WSL) | ||
|
|
||
| ### Go | ||
|
|
||
| Ignite CLI is written in the Go programming language. To use Ignite CLI on a local system: | ||
|
|
||
| - Install [Go](https://golang.org/doc/install) (**version 1.19** or higher) | ||
| - Ensure the Go environment variables are [set properly](https://golang.org/doc/gopath_code#GOPATH) on your system | ||
|
|
||
| ## Verify your Ignite CLI version | ||
|
|
||
| To verify the version of Ignite CLI you have installed, run the following command: | ||
|
|
||
| ```bash | ||
| ignite version | ||
| ``` | ||
|
|
||
| ## Installing Ignite CLI | ||
|
|
||
| To install the latest version of the `ignite` binary use the following command. | ||
|
|
||
| ```bash | ||
| curl https://get.ignite.com/cli! | bash | ||
| ``` | ||
|
|
||
| This command invokes `curl` to download the installation script and pipes the output to `bash` to perform the | ||
| installation. The `ignite` binary is installed in `/usr/local/bin`. | ||
|
|
||
| To learn more or customize the installation process, see the [installer docs](https://github.com/ignite/installer) on | ||
| GitHub. | ||
|
|
||
| ### Write permission | ||
|
|
||
| Ignite CLI installation requires write permission to the `/usr/local/bin/` directory. If the installation fails because | ||
| you do not have write permission to `/usr/local/bin/`, run the following command: | ||
|
|
||
| ```bash | ||
| curl https://get.ignite.com/cli | bash | ||
| ``` | ||
|
|
||
| Then run this command to move the `ignite` executable to `/usr/local/bin/`: | ||
|
|
||
| ```bash | ||
| sudo mv ignite /usr/local/bin/ | ||
| ``` | ||
|
|
||
| On some machines, a permissions error occurs: | ||
|
|
||
| ```bash | ||
| mv: rename ./ignite to /usr/local/bin/ignite: Permission denied | ||
| ============ | ||
| Error: mv failed | ||
| ``` | ||
|
|
||
| In this case, use sudo before `curl` and before `bash`: | ||
|
|
||
| ```bash | ||
| sudo curl https://get.ignite.com/cli | sudo bash | ||
| ``` | ||
|
|
||
| ## Upgrading your Ignite CLI installation | ||
|
|
||
| Before you install a new version of Ignite CLI, remove all existing Ignite CLI installations. | ||
|
|
||
| To remove the current Ignite CLI installation: | ||
|
|
||
| 1. On your terminal window, press `Ctrl+C` to stop the chain that you started with `ignite chain serve`. | ||
| 2. Remove the Ignite CLI binary with `rm $(which ignite)`. | ||
| Depending on your user permissions, run the command with or without `sudo`. | ||
| 3. Repeat this step until all `ignite` installations are removed from your system. | ||
|
|
||
| After all existing Ignite CLI installations are removed, follow the [Installing Ignite CLI](#installing-ignite-cli) | ||
| instructions. | ||
|
|
||
| For details on version features and changes, see | ||
| the [changelog.md](https://github.com/ignite/cli/blob/main/changelog.md) | ||
| in the repo. | ||
|
|
||
| ## Build from source | ||
|
|
||
| To experiment with the source code, you can build from source: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/ignite/cli --depth=1 | ||
| cd cli && make install | ||
| ``` | ||
|
|
||
| ## Summary | ||
|
|
||
| - Verify the prerequisites. | ||
| - To set up a local development environment, install Ignite CLI locally on your computer. | ||
| - Install Ignite CLI by fetching the binary using cURL or by building from source. | ||
| - The latest version is installed by default. You can install previous versions of the precompiled `ignite` binary. | ||
| - Stop the chain and remove existing versions before installing a new version. |
4 changes: 4 additions & 0 deletions
4
docs/versioned_docs/version-v0.27.2/01-welcome/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Welcome", | ||
| "link": null | ||
| } |
36 changes: 36 additions & 0 deletions
36
docs/versioned_docs/version-v0.27.2/02-guide/00-introduction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| sidebar_position: 0 | ||
| title: Introduction | ||
| slug: /guide | ||
| --- | ||
|
|
||
| # Introduction | ||
|
|
||
| Developer tutorials provide step-by-step instructions to help you build blockchain developer skills. | ||
|
|
||
| By following these developer tutorials you will learn how to: | ||
|
|
||
| * Install Ignite CLI on your local machine | ||
| * Create a new blockchain and start a node locally for development | ||
| * Make your blockchain say "Hello, World!" | ||
| * Scaffold a Cosmos SDK query | ||
| * Modify a keeper method to return a static string | ||
| * Use the blockchain CLI to make a query | ||
| * Write and read blog posts to your chain in the Blog tutorial | ||
| * Scaffold a Cosmos SDK message | ||
| * Define new types in protocol buffer files | ||
| * Write keeper methods to write data to the store | ||
| * Read data from the store and return it as a result a query | ||
| * Use the blockchain CLI to broadcast transactions | ||
| * Build a blockchain for buying and selling names in the Nameservice tutorial | ||
| * Scaffold CRUD logic with `map` | ||
| * Use other module methods in your custom module | ||
| * Send tokens between addresses | ||
| * Build a guessing game with rewards | ||
| * Use an escrow account to store tokens | ||
| * Use the Inter-Blockchain Communication (IBC) protocol | ||
| * Scaffold an IBC-enabled module | ||
| * Send and receive IBC packets | ||
| * Configure and run a built-in IBC relayer | ||
| * Build a decentralized order-book token exchange | ||
| * Build an advanced IBC-enabled module |
Oops, something went wrong.