Skip to content

hyperweb-io/create-hyperweb-app

Repository files navigation

create-hyperweb-app

Set up a Hyperweb app by running one command ⚛️

Overview

First, install create-hyperweb-app globally using npm:

npm install -g create-hyperweb-app

Then, create your new Cosmos app by running the following command:

# you can also use `cha` instead of `create-hyperweb-app` for shortcut ;)
create-hyperweb-app

During the setup process, you'll be prompted to enter the name of your app. For example:

> name: my-app

Note: You must have an SSH key added to your GitHub account to complete the setup process. For instructions on how to generate and add an SSH key, please refer to GitHub's documentation.

Once the app is created, move into the app directory and start the development server:

cd my-app
yarn && yarn dev

Now your app should be running on http://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 20+ wallets via Cosmos Kit — including Ledger, Keplr, Cosmostation, Leap, Trust Wallet, OKX, XDEFI, Exodus, Wallet Connect and more!
  • ⚛️ Sign and broadcast with cosmjs stargate + cosmwasm signers
  • 🛠 Render pages with next.js hybrid static & server rendering
  • 🚀 Ensure reliability with Starship, our end-to-end testing CI/CD project for GitHub Actions, streamlining continuous integration and delivery across the interchain ecosystem.

Creating an App

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

global install

npm install -g create-hyperweb-app

Then run the command:

create-hyperweb-app

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

cha

npx

npx create-hyperweb-app

npm

npm init hyperweb-app

Yarn

yarn create hyperweb-app

Templates

The create-hyperweb-app tool provides carefully crafted templates to help you understand and test various features and integrations. By executing the templates, you can quickly see how to implement specific functionalities in your Cosmos app.

cha --template

If you know the template name, you can do

cha --template <template-name>

Alternatively, you can use the shorthand -t flag to achieve the same:

cha -t <template-name>

This command will generate a new project configured with the selected template, allowing you to dive into the code and functionality right away.

Hyperweb

Facilitate the development of decentralized applications by enabling developers to write and compile TypeScript smart contracts locally.

cha --name hyperweb-template --template hyperweb

Chain Admin

Manage and integrate multiple modules such as staking, voting and asset-list within your application. This template provides a comprehensive setup for building robust and feature-rich Cosmos apps.

cha --name chain-admin-template --template chain-admin

Options

Argument Description Default
--repo Set custom repository for cha templates None
--install Automatically install dependencies true
--printCmd Print the command to run after setup true
-n, --name Provide a project name None
-e, --example Provide an example name None
-t, --template Define the template to use None
-b, --fromBranch Specify the branch to use for cloning None

Interchain JavaScript Stack ⚛️

A unified toolkit for building applications and smart contracts in the Interchain ecosystem

Category Tools Description
Chain Information Chain Registry, Utils, Client Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
Wallet Connectors Interchain Kitbeta, Cosmos Kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
Signing Clients InterchainJSbeta, CosmJS A single, universal signing interface for any network
SDK Clients Telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
Starter Kits Create Interchain Appbeta, Create Cosmos App Set up a modern Interchain app by running one command.
UI Kits Interchain UI The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
Testing Frameworks Starship Unified Testing and Development for the Interchain.
TypeScript Smart Contracts Create Hyperweb App Build and deploy full-stack blockchain applications with TypeScript
CosmWasm Contracts CosmWasm TS Codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.

Credits

🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to our github ⚛️

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, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

About

One-Command Setup for TypeScript Smart Contracts and Hyperweb dApps

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages