https://github.com/hyperweb-io/ts-codegen-module-boilerplate
https://github.com/hyperweb-io/ts-codegen-module-boilerplate
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hyperweb-io/ts-codegen-module-boilerplate
- Owner: hyperweb-io
- License: mit
- Created: 2022-04-17T20:08:34.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-19T02:59:39.000Z (over 2 years ago)
- Last Synced: 2025-03-13T02:03:50.585Z (over 1 year ago)
- Language: JavaScript
- Size: 42 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# __MODULENAME__
__MODULEDESC__
## install
```sh
npm install __MODULENAME__
```
## Table of contents
- [__MODULENAME__](#__MODULENAME__)
- [Install](#install)
- [Table of contents](#table-of-contents)
- [Developing](#developing)
- [Credits](#credits)
## Developing
When first cloning the repo:
```
yarn
yarn build
```
### Codegen
Contract schemas live in `./contracts`. Look inside of `scripts/codegen.js` and configure the settings for bundling your SDK and contracts into `__MODULENAME__`:
```
yarn codegen
```
### Publishing
Build the types and then publish:
```
yarn build
yarn publish
```
## Credits
🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.zone/validator)
Code built with the help of these related projects:
* [@cosmology/telescope](https://github.com/cosmology-tech/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
* [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) for generated CosmWasm contract Typescript classes
* [chain-registry](https://github.com/cosmology-tech/chain-registry) an npm module for the official Cosmos chain-registry.
* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) A wallet connector for the Cosmos ⚛️
* [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) set up a modern Cosmos app by running one command.
* [starship](https://github.com/cosmology-tech/starship) a k8s-based unified development environment for Cosmos Ecosystem
## 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 software using the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.