Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add isVeWorldSupported variable #259

Merged
merged 5 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 27 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,37 @@ The following is a set of guidelines for contributing to **AppHub**. These
are just guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.

## Rules

1. The app must run on Mainnet
2. Support [Connex](https://connex.vecha.in/#/)
3. Logo is required
4. The id must be unique
5. Short and simple descriptions
3. Logo is required
4. The id must be unique
5. Short and simple descriptions
6. Comply with directory & contents rules
7. One application per submission

## Adding your app

To add your application, you need to create your app details and make a pull request for the maintainers to review your app and merge into AppHub.

Recommended workflow:

- Fork the AppHub
- Create a new branch
- Create your app details and upload to the proper directory
- Make the pull request

Ref:
Ref:

- [Fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
- [Clone a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
- [Creating a new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)
- [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
- [Tutorial: How to make your first pull request on Github by *Thanoshan MV*](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/)
- [Tutorial: How to make your first pull request on Github by _Thanoshan MV_](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/)

### Create a directory
Once the AppHub is forked, create a new directory in the `apps` directory with unique id and include a `manifest.json` file and `logo.png` file. To create a unique id, you can append the name of the application to the reversed domain such as `com.example.your-app-name`. Your app directory structure should be look like this

Once the AppHub is forked, create a new directory in the `apps` directory with unique id and include a `manifest.json` file and `logo.png` file. To create a unique id, you can append the name of the application to the reversed domain such as `com.example.your-app-name`. Your app directory structure should be look like this

```
├── apps
Expand All @@ -42,6 +48,7 @@ Once the AppHub is forked, create a new directory in the `apps` directory with u
```

### Create a JSON File & Rules

Create a `manifest.json` file includes app details.

```
Expand All @@ -56,20 +63,23 @@ Create a `manifest.json` file includes app details.
"contracts": [
"0x1234567890123456789012345678901234567890",
"0x0987654321098765432109876543210987654321"
]
],
"isVeWorldSupported": false
}
```

- `name` is **required**.
- `href` is **required**, and must be a fully-qualified URL.
- `desc` is **required**.
- `category` is **required**, and must be one of the provided category.
- `tags` is **required**, should be ***an array*** if provided.
- `repo` is *optional*, and must be a fully-qualified URL.
- `contracts` is *optional*, should be ***an array*** and ***lower cases*** if provided
- `tags` is **required**, should be **_an array_** if provided.
- `isVeWorldSupported` is **required**, set this to true if your dApp supports the VeWorld browser extension, enabling its use within the VeWorld mobile wallet. Your dApp will then be listed in the dApp section of the VeWorld mobile discovery.
- `repo` is _optional_, and must be a fully-qualified URL.
- `contracts` is _optional_, should be **_an array_** and **_lower cases_** if provided
- No fields should be left blank.

### Categories

`category` is required and must be one of the following values:

- collectibles
Expand All @@ -79,25 +89,28 @@ Create a `manifest.json` file includes app details.
- utilities

### Import the Logo & Rules

Import your app logo into the directory and name it `logo`.

> A logo is a symbol made up of text and images that identifies an application.

- Must be a `.png`
- Must be `512px by 512px`
- Must **not** be a copy of another company's or application's logo
- Must **not** contain any marketing information (including but not limited to social media links/sale date)


### Submission Guidelines

- **The pull request should have a clean git history.**
- Don't use another company's trademarks (icon, logo or name) without supplying evidence of prior permission
- Create a directory under `/apps/` and contains the *manifest.json* and the *logo.png*
- Create a directory under `/apps/` and contains the _manifest.json_ and the _logo.png_
- Keep description short and simple, but descriptive.
- Check your spelling and grammar.
- URL must have schemes of ***http*** or ***https***.
- URL must have schemes of **_http_** or **_https_**.
- Logo complies with the logo rules

> If the maintainers/reviewer notice anything that we'd like changed, we'll ask you to edit your PR before we merge it.
> If the maintainers/reviewer notice anything that we'd like changed, we'll ask you to edit your PR before we merge it.

## Last but not least

When users interact with your application, the function names and parameters are encoded as hex values in clause data field which is not very human-readable. You can submit the ABIs on [b32](https://github.com/vechain/b32) to help the user understand more about the interaction details.
16 changes: 11 additions & 5 deletions apps/app.vercel.vet-token-transfer/manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
{
"name" : "Token Transfer",
"href" : "https://vet-token-transfer.vercel.app/" ,
"desc" : "Transfer any of the VIP-180 tokens in the vechain ecosystem!",
"name": "Token Transfer",
"href": "https://vet-token-transfer.vercel.app/",
"desc": "Transfer any of the VIP-180 tokens in the vechain ecosystem!",
"category": "utilities",
"tags" : ["transfer","tokens","tool","utility"]
}
"tags": [
"transfer",
"tokens",
"tool",
"utility"
],
"isVeWorldSupported": true
}
17 changes: 12 additions & 5 deletions apps/art.squadvechain/manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
{
"name" : "SQUAD VeChain",
"href" : "https://SquadVechain.Art/" ,
"desc" : "Join the $SQUAD Today, Bringing DeFi & NFTs Closer to each other!",
"name": "SQUAD VeChain",
"href": "https://SquadVechain.Art/",
"desc": "Join the $SQUAD Today, Bringing DeFi & NFTs Closer to each other!",
"category": "defi",
"tags" : ["DeFi","tokens","ICO","Memecoin","NFT"]
}
"tags": [
"DeFi",
"tokens",
"ICO",
"Memecoin",
"NFT"
],
"isVeWorldSupported": false
}
9 changes: 7 additions & 2 deletions apps/com.2048x.2048x/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,10 @@
"href": "https://play2048x.com",
"desc": "2048x is a challenging number puzzle for kids and grown ups.",
"category": "games",
"tags": ["game", "games", "fun"]
}
"tags": [
"game",
"games",
"fun"
],
"isVeWorldSupported": false
}
8 changes: 6 additions & 2 deletions apps/com.bc66.lucky-airdrop/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@
"href": "https://bc66.github.io/lucky-airdrop/",
"desc": "Sending red envelopes is a way to send good wishes and luck (as well as money).",
"category": "utilities",
"tags": ["game", "red envelope"]
}
"tags": [
"game",
"red envelope"
],
"isVeWorldSupported": false
}
22 changes: 15 additions & 7 deletions apps/com.blackvemarket/manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
{
"name": "BlackVeMarket",
"href": "https://blackvemarket.com",
"desc": "Discover Limitless NFT Experiences with BlackVeMarket: Where the VeFam Unites! Join our Vibrant Community and Explore the Boundless World of Digital Collectibles, Trading, and Creativity. Embrace the Future of NFTs and Unleash Your Imagination with BlackVeMarket!",
"category": "marketplaces",
"tags": ["NFT", "Marketplace", "VIP-181", "Collectibles", "VNFT", "BlackVe"]
}
{
"name": "BlackVeMarket",
"href": "https://blackvemarket.com",
"desc": "Discover Limitless NFT Experiences with BlackVeMarket: Where the VeFam Unites! Join our Vibrant Community and Explore the Boundless World of Digital Collectibles, Trading, and Creativity. Embrace the Future of NFTs and Unleash Your Imagination with BlackVeMarket!",
"category": "marketplaces",
"tags": [
"NFT",
"Marketplace",
"VIP-181",
"Collectibles",
"VNFT",
"BlackVe"
],
"isVeWorldSupported": true
}
12 changes: 10 additions & 2 deletions apps/com.defibetclub/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,13 @@
"href": "https://app.defibetclub.com/",
"desc": "A fun, safe private members club built on VeChain for sports betting enthusiasts!",
"category": "games",
"tags": ["NFT","Bets","Sports","VIP-181","Collectibles", "Gambling"]
}
"tags": [
"NFT",
"Bets",
"Sports",
"VIP-181",
"Collectibles",
"Gambling"
],
"isVeWorldSupported": true
}
14 changes: 12 additions & 2 deletions apps/com.dragonsofsingapura/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,15 @@
"href": "https://dragonsofsingapura.com/",
"desc": "Welcome to Singapura! World of the Dragon a land steeped in history, culture, intrigue and mystery. Join the Tribes mount your Dragon! and write your name in the history books..",
"category": "collectibles",
"tags": ["NFT", "Dragons of Singapura", "VIP-181", "Collectibles", "VNFT", "Staking", "Breeding", "Metaverse"]
}
"tags": [
"NFT",
"Dragons of Singapura",
"VIP-181",
"Collectibles",
"VNFT",
"Staking",
"Breeding",
"Metaverse"
],
"isVeWorldSupported": false
}
7 changes: 6 additions & 1 deletion apps/com.laalaguer.token-transfer/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,10 @@
"href": "https://laalaguer.github.io/vechain-token-transfer/",
"desc": "Listing of all VIP180 VeChain tokens and enables their transfer.",
"category": "defi",
"tags": ["vip180", "token", "transfer"]
"tags": [
"vip180",
"token",
"transfer"
],
"isVeWorldSupported": false
}
11 changes: 9 additions & 2 deletions apps/com.non-fungibulls/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,12 @@
"href": "https://non-fungibulls.com",
"desc": "Non FungiBulls is a collection of 1,450 NFTs on the VechainThor blockchain. It is a community based utility collection and a support token for our main project, Non Fungible News.",
"category": "collectibles",
"tags": ["NFT","non fungibulls","Collectibles","VNFT","Non Fungible News"]
}
"tags": [
"NFT",
"non fungibulls",
"Collectibles",
"VNFT",
"Non Fungible News"
],
"isVeWorldSupported": true
}
11 changes: 9 additions & 2 deletions apps/com.sharksofanarchy/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,12 @@
"href": "https://sharksofanarchy.com/",
"desc": "Sharks of anarchy, The first motorcycle Gang on VeChain! Will get their own DLC inside Thugs Paradise P2E Game.",
"category": "collectibles",
"tags": ["VIP-181", "VNFT", "collectable", "sharks", "pixelart"]
}
"tags": [
"VIP-181",
"VNFT",
"collectable",
"sharks",
"pixelart"
],
"isVeWorldSupported": false
}
11 changes: 9 additions & 2 deletions apps/com.smuzzies.3dables/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,12 @@
"href": "https://3dables.smuzzies.com/",
"desc": "3DAbles is a collection of user generated artwork spanning the entire VeChainThor ecosystem and is a product of the Smuzzies development team.",
"category": "collectibles",
"tags": ["Smuzzies","VIP-181","Collectibles","VNFT","NFT"]
}
"tags": [
"Smuzzies",
"VIP-181",
"Collectibles",
"VNFT",
"NFT"
],
"isVeWorldSupported": true
}
12 changes: 10 additions & 2 deletions apps/com.theinkaempire/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,13 @@
"href": "https://theinkaempirenft.com",
"desc": "The Inka Empire is a PFP collection of 5,000 NFTs. The Story will contain the best kept secrets of the largest empire in Pre-Columbian America (1529 A.D.). A Chronicle that will reveal the true heritage of an empire full of mysteries and legends...",
"category": "collectibles",
"tags": ["NFT", "TheInkaEmpire", "VIP-181", "Collectibles", "VNFT", "PFP"]
}
"tags": [
"NFT",
"TheInkaEmpire",
"VIP-181",
"Collectibles",
"VNFT",
"PFP"
],
"isVeWorldSupported": false
}
15 changes: 10 additions & 5 deletions apps/com.vechain.bmac/manifest.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"name" : "Buy me a coffee",
"href" : "https://bmac.vecha.in/" ,
"desc" : "allows your supporter to support your work by donating VET",
"name": "Buy me a coffee",
"href": "https://bmac.vecha.in/",
"desc": "allows your supporter to support your work by donating VET",
"category": "utilities",
"tags" : ["social","donation","tool"],
"repo": "https://github.com/vechain/buy-me-a-coffee"
"tags": [
"social",
"donation",
"tool"
],
"repo": "https://github.com/vechain/buy-me-a-coffee",
"isVeWorldSupported": false
}
15 changes: 10 additions & 5 deletions apps/com.vechain.insight/manifest.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"name" : "Insight",
"href" : "https://insight.vecha.in/" ,
"desc" : "Serverless VeChain explorer. It allows you to explore and search for blocks, transactions and accounts.",
"name": "Insight",
"href": "https://insight.vecha.in/",
"desc": "Serverless VeChain explorer. It allows you to explore and search for blocks, transactions and accounts.",
"category": "utilities",
"tags" : ["utilities","explorer","tool"],
"repo": "https://github.com/vechain/insight-app"
"tags": [
"utilities",
"explorer",
"tool"
],
"repo": "https://github.com/vechain/insight-app",
"isVeWorldSupported": false
}
15 changes: 10 additions & 5 deletions apps/com.vechain.inspector/manifest.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"name" : "Inspector",
"href" : "https://inspector.vecha.in" ,
"desc" :"A tool that allows you to deploy and interact with the contract",
"name": "Inspector",
"href": "https://inspector.vecha.in",
"desc": "A tool that allows you to deploy and interact with the contract",
"category": "utilities",
"tags" : ["contract","deploy","tool"],
"repo": "https://github.com/vechain/inspector-app"
"tags": [
"contract",
"deploy",
"tool"
],
"repo": "https://github.com/vechain/inspector-app",
"isVeWorldSupported": true
}
16 changes: 11 additions & 5 deletions apps/com.vechain.tokens/manifest.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
{
"name" : "My Tokens",
"href" : "https://tokens.vecha.in/#/" ,
"desc" : "My Tokens,My Treasure ",
"name": "My Tokens",
"href": "https://tokens.vecha.in/#/",
"desc": "My Tokens,My Treasure ",
"category": "defi",
"tags" : ["transfer","tokens","tool","utility"],
"repo": "https://github.com/vechain/my-tokens"
"tags": [
"transfer",
"tokens",
"tool",
"utility"
],
"repo": "https://github.com/vechain/my-tokens",
"isVeWorldSupported": false
}
Loading
Loading