create-cosmos-app

Set up a modern Cosmos app by running one command ⚛️

Demo

https://user-images.githubusercontent.com/545047/192061992-f0e1106d-f4b2-4879-ab0a-896f22ee4f49.mp4

Overview

# install
npm install -g create-cosmos-app

# run one command
create-cosmos-app

> name: my-app
cd my-app
yarn && yarn dev

# now your app is running on localhost:3000!

Get Started Immediately

You don’t need to install or configure cosmjs, keplr, nextjs, webpack or Babel.

Everything is preconfigured, ready-to-go, so you can focus on your code!

• ⚡️ Connect easily to 15+ wallets via Cosmos Kit — including Ledger, Keplr, Cosmostation, Leap, Trust Wallet, XDEFI, Exodus, Wallet Connect and more!
• ⚛️ Sign and broadcast with cosmjs stargate + cosmwasm signers
• 🛠 Render pages with next.js hybrid static & server rendering
• 🎨 Build awesome UI with Cosmos Kit UI and Chakra UI
• 📝 Leverage chain-registry for Chain and Asset info for all Cosmos chains

Education & Resources

🎥 Checkout our videos to learn to learn more about create-cosmos-app and tooling for building frontends in the Cosmos!

Checkout cosmos-kit for more docs as well as cosmos-kit/react for getting cosmjs stargate and cosmjs signers.

Creating an App

To create a new app, you may choose one of the following methods:

global install

npm install -g create-cosmos-app

Then run the command:

create-cosmos-app

we also made an alias cca if you don't want to type create-cosmos-app:

cca

npx

npx create-cosmos-app

npm

npm init cosmos-app

Yarn

yarn create cosmos-app

Examples

Explore examples!

cca --example

Send Tokens

cca --name send-example --example --template send-tokens

Stake Tokens

cca --name stake-example --example --template stake-tokens

Vote Proposal

cca --name vote-example --example --template vote-proposal

IBC Transfer

cca --name ibc-example --example --template ibc-transfer

grpc-web and grpc-gateway

cca --name grpc-example --example --template grpc-web-grpc-gateway

Osmosis

uses osmojs

cca --name osmo-example --example --template osmosis

or the cosmwasm example:

cca --name osmowasm-example --example --template osmosis-cosmwasm

Swap Tokens

uses osmojs to swap tokens

cca --name swap-example --example --template swap-tokens

Provide Liquidity

uses osmojs to provide liquidity

cca --name liquidity-example --example --template provide-liquidity

Asset List

cca --name asset-list-example --example --template asset-list

Juno

uses juno-network

cca --name juno-example --example --template juno

Stargaze

uses stargazejs

cca --name stargaze-example --example --template stargaze

NFT

uses stargazejs

cca --name nft-example --example --template nft

CosmWasm

cca --name cosmwasm-example --example --template cosmwasm

Tailwind

cca --name tailwind-example --example --template tailwindcss

Development

Because the nature of how template boilerplates are generated, we generate yarn.lock files inside of nested packages so we can fix versions to avoid non-deterministic installations.

When adding packages, yarn workspaces will use the root yarn.lock. It could be ideal to remove it while adding packages, and when publishing or pushing new changes, generating the nested lock files.

In the root, to remove all nested lock files:

yarn locks:remove

When you need to remove/generate locks for all nested packages, simply run yarn locks in the root:

yarn locks

Related

Checkout these related projects:

• @cosmwasm/ts-codegen for generated CosmWasm contract Typescript classes
• @osmonauts/telescope a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
• chain-registry an npm module for the official Cosmos chain-registry.
• cosmos-kit A wallet connector for the Cosmos ⚛️
• create-cosmos-app set up a modern Cosmos app by running one command.
• starship a k8s-based unified development environment for Cosmos Ecosystem

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code or CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.