https://github.com/hyperweb-io/create-hyperweb-app
One-Command Setup for TypeScript Smart Contracts and Hyperweb dApps
https://github.com/hyperweb-io/create-hyperweb-app
Last synced: 4 months ago
JSON representation
One-Command Setup for TypeScript Smart Contracts and Hyperweb dApps
- Host: GitHub
- URL: https://github.com/hyperweb-io/create-hyperweb-app
- Owner: hyperweb-io
- License: mit
- Created: 2024-10-04T19:22:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-26T13:13:37.000Z (12 months ago)
- Last Synced: 2025-06-26T13:46:11.550Z (12 months ago)
- Language: TypeScript
- Homepage: https://hyperweb.io/stack/create-hyperweb-app
- Size: 26.9 MB
- Stars: 15
- Watchers: 6
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-hyperweb-app
Set up a Hyperweb app by running one command ⚛️
- [Overview](#overview)
- [Education & Resources](#education--resources)
- [Creating an App](#creating-an-app)
- [Templates](#templates)
- [Options](#options)
- [Development](#development)
## Overview
First, install `create-hyperweb-app` globally using npm:
```sh
npm install -g create-hyperweb-app
```
Then, create your new Cosmos app by running the following command:
```sh
# 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:
```plaintext
> 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](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
Once the app is created, move into the app directory and start the development server:
```sh
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](https://github.com/hyperweb-io/cosmos-kit) — including Ledger, Keplr, Cosmostation, Leap, Trust Wallet, OKX, XDEFI, Exodus, Wallet Connect and more!
- ⚛️ Sign and broadcast with [cosmjs](https://github.com/cosmos/cosmjs) stargate + cosmwasm signers
- 🛠 Render pages with [next.js](https://nextjs.org/) hybrid static & server rendering
- 🚀 Ensure reliability with [Starship](https://github.com/hyperweb-io/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
```sh
npm install -g create-hyperweb-app
```
Then run the command:
```sh
create-hyperweb-app
```
we also made an alias `cha` if you don't want to type `create-hyperweb-app`:
```sh
cha
```
### npx
```sh
npx create-hyperweb-app
```
### npm
```sh
npm init hyperweb-app
```
### Yarn
```sh
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
```
Alternatively, you can use the shorthand `-t` flag to achieve the same:
```
cha -t
```
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**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |
| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)beta, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)beta, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)beta, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |
| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |
| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/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 ⚛️](https://github.com/hyperweb-io)
## 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.