Skip to content

Commit

Permalink
Prepare boilerplate for create-hyperweb-app
Browse files Browse the repository at this point in the history
  • Loading branch information
Anmol1696 authored and github-actions[bot] committed Oct 17, 2024
1 parent 26dd2ff commit 2eb0214
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 10 deletions.
42 changes: 42 additions & 0 deletions .question.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[
{
"name": "__USERFULLNAME__",
"message": "Enter author full name",
"required": true
},
{
"name": "__USEREMAIL__",
"message": "Enter author email",
"required": true
},
{
"name": "__MODULENAME__",
"message": "Enter the module name",
"required": true
},
{
"name": "__MODULEDESC__",
"message": "Enter the module description",
"required": true
},
{
"name": "__REPONAME__",
"message": "Enter the repository name",
"required": true
},
{
"name": "__USERNAME__",
"message": "Enter your github username",
"required": true
},
{
"name": "__ACCESS__",
"message": "Module access?",
"choices": [
"public",
"restricted"
],
"type": "list",
"required": true
}
]
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# hyperweb
# __MODULENAME__

<p align="center" width="100%">
<img height="90" src="https://github.com/user-attachments/assets/f672f9b8-e59a-4f44-8f51-df3e8d2eaae5" />
__MODULEDESC__
</p>

<p align="center" width="100%">
<a href="https://github.com/hyperweb-io/hyperweb-boilerplate/actions/workflows/e2e-tests.yaml">
<img height="20" src="https://github.com/hyperweb-io/hyperweb-boilerplate/actions/workflows/e2e-tests.yaml/badge.svg" />
<a href="https://github.com/__USERNAME__/__REPONAME__/actions/workflows/e2e-tests.yaml">
<img height="20" src="https://github.com/__USERNAME__/__REPONAME__/actions/workflows/e2e-tests.yaml/badge.svg" />
</a>
<br />
<a href="https://github.com/hyperweb-io/hyperweb-boilerplate/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://github.com/__USERNAME__/__REPONAME__/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://github.com/cosmology-tech/starshipjs"><img height="20" src="https://img.shields.io/badge/CI-Starship-blue"></a>
</p>

Expand Down Expand Up @@ -39,13 +40,14 @@ Welcome to **Hyperweb**, the blockchain for JavaScript smart contracts. Hyperweb
- [Evaluating Functions on the Contract](#evaluating-functions-on-the-contract)
- [Reading Contract State](#reading-contract-state)
- [Development](#development)
- [Disclaimer](#disclaimer)

## Installation

1. Clone the repository:

```bash
git clone https://github.com/hyperweb-io/hyperweb-boilerplate.git
git clone https://github.com/__USERNAME__/__REPONAME__.git

yarn
```
Expand Down Expand Up @@ -248,3 +250,7 @@ console.log('Contract state:', state);
## Development

For local development, you can run the tests provided in the `__tests__/` folder to validate contract functionality using `starshipjs` to simulate chain interactions.

## 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.
14 changes: 9 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
{
"name": "hyperweb",
"version": "0.0.1",
"description": "Hyperweb smart contracts",
"author": "Hyperweb <[email protected]>",
"homepage": "https://github.com/hyperweb-io/hyperweb#readme",
"author": "__USERFULLNAME__ <__USEREMAIL__>",
"description": "__MODULEDESC__",
"homepage": "https://github.com/__USERNAME__/__REPONAME__",
"license": "SEE LICENSE IN LICENSE",
"repository": {
"type": "git",
"url": "https://github.com/hyperweb-io/hyperweb"
"url": "https://github.com/__USERNAME__/__REPONAME__"
},
"bugs": {
"url": "https://github.com/hyperweb-io/hyperweb/issues"
"url": "https://github.com/__USERNAME__/__REPONAME__/issues"
},
"publishConfig": {
"access": "__ACCESS__",
"directory": "dist"
},
"scripts": {
"clean": "rimraf dist/contracts/**",
Expand Down

0 comments on commit 2eb0214

Please sign in to comment.