Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
50 lines
1.7 KiB
Text
50 lines
1.7 KiB
Text
# <%= AppName %>
|
|
**<%= AppName %>** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli).
|
|
|
|
## Get started
|
|
|
|
```
|
|
ignite chain serve
|
|
```
|
|
|
|
`serve` command installs dependencies, builds, initializes, and starts your blockchain in development.
|
|
|
|
### Configure
|
|
|
|
Your blockchain in development can be configured with `config.yml`. To learn more, see the [Ignite CLI docs](https://docs.ignite.com).
|
|
|
|
### Web Frontend
|
|
|
|
Additionally, Ignite CLI offers a frontend scaffolding feature (based on Vue) to help you quickly build a web frontend for your blockchain:
|
|
|
|
Use: `ignite scaffold vue`
|
|
This command can be run within your scaffolded blockchain project.
|
|
|
|
|
|
For more information see the [monorepo for Ignite front-end development](https://github.com/ignite/web).
|
|
|
|
## Release
|
|
To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created.
|
|
|
|
```
|
|
git tag v0.1
|
|
git push origin v0.1
|
|
```
|
|
|
|
After a draft release is created, make your final changes from the release page and publish it.
|
|
|
|
### Install
|
|
To install the latest version of your blockchain node's binary, execute the following command on your machine:
|
|
|
|
```
|
|
curl https://get.ignite.com/<%= GitHubPath %>@latest! | sudo bash
|
|
```
|
|
`<%= GitHubPath %>` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/ignite/installer).
|
|
|
|
## Learn more
|
|
|
|
- [Ignite CLI](https://ignite.com/cli)
|
|
- [Tutorials](https://docs.ignite.com/guide)
|
|
- [Ignite CLI docs](https://docs.ignite.com)
|
|
- [Cosmos SDK docs](https://docs.cosmos.network)
|
|
- [Developer Chat](https://discord.com/invite/ignitecli)
|