-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
44a35f2
commit bc1c88a
Showing
1 changed file
with
52 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,53 @@ | ||
# cosmos-sdk | ||
# xarchain | ||
**xarchain** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli). | ||
|
||
Cosmos SDK to explore mainly ABCI++ capabilities | ||
|
||
## 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 both Vue and React options for frontend scaffolding: | ||
|
||
For a Vue frontend, use: `ignite scaffold vue` | ||
For a React frontend, use: `ignite scaffold react` | ||
These commands 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/username/xarchain@latest! | sudo bash | ||
``` | ||
`username/xarchain` 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/allinbits/starport-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.gg/ignite) |