Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt committed Jun 7, 2024
1 parent d271ae5 commit 1cae9a8
Show file tree
Hide file tree
Showing 14 changed files with 200 additions and 311 deletions.
52 changes: 2 additions & 50 deletions _registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,56 +15,8 @@ To add your app to the Ignite App Registry, follow these steps:

## `app.json` File Structure**

Below is the template for the `username.repository.app_name.json` file. Replace each placeholder with the specific details of your app.

```json
{
"appName": "Your App Name",
"appDescription": "A brief description of what your app does.",
"ignite": ">28.3.0",
"dependencies": {
"docker": ">23.0.5"
},
"cosmosSDK": ">0.50.4",
"features": [
"Feature 1",
"Feature 2",
"Additional features..."
],
"wasm": false,
"authors": [
{
"name": "Author Name",
"email": "email@example.com",
"website": "Optional author or company website"
}
],
"repository": {
"url": "URL to the app's repository"
},
"documentationUrl": "URL to the app's documentation",
"license": {
"name": "MIT",
"url": "github.com/username/app/LICENSE.md"
},
"keywords": ["keyword1", "keyword2", "Useful for search and categorization"],
"supportedPlatforms": ["mac", "linux"],
"socialMedia": {
"x": "Optional X handle",
"telegram": "Optional Telegram group",
"discord": "Optional Discord server",
"reddit": "Optional Reddit page",
"website": ""
},
"donations": {
"cryptoAddresses": {
"cosmos": "cosmos1...",
"otherSupportedCryptos": "address"
},
"fiatDonationLinks": "URL to Patreon, Ko-fi, etc."
}
}
```
The expected template of the `username.repository.app_name.json` file can be found [here](./registry.json).
Replace each placeholder with the specific details of your app.

## Best Practices

Expand Down
27 changes: 3 additions & 24 deletions _registry/ignite.apps.explorer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@
"docker": ">23.0.5"
},
"cosmosSDK": ">0.50.4",
"features": [
"CLI Explorer",
"Gex"
],
"wasm": false,
"authors": [
{
"name": "Jeronimo Albi",
Expand All @@ -19,13 +14,11 @@
"github": "jeronimoalbi"
}
],
"repository": {
"url": "https://github.com/ignite/apps/tree/main/explorer"
},
"repositoryUrl": "https://github.com/ignite/apps/explorer",
"documentationUrl": "https://github.com/cosmos/gex",
"license": {
"name": "MIT",
"url": "github.com/username/app/LICENSE.md"
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"explorer",
Expand All @@ -36,19 +29,5 @@
"supportedPlatforms": [
"mac",
"linux"
],
"socialMedia": {
"x": "",
"telegram": "",
"discord": "",
"reddit": "",
"website": ""
},
"donations": {
"cryptoAddresses": {
"cosmos": "",
"otherSupportedCryptos": ""
},
"fiatDonationLinks": ""
}
]
}
26 changes: 3 additions & 23 deletions _registry/ignite.apps.hermes.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
"ignite": ">0.27.0",
"dependencies": {},
"cosmosSDK": ">0.50.1",
"features": [
"IBC relayer"
],
"wasm": false,
"authors": [
{
"name": "Danilo Pantani",
Expand All @@ -16,13 +12,11 @@
"github": "pantani"
}
],
"repository": {
"url": "https://github.com/ignite/apps/tree/main/hermes"
},
"repositoryUrl": "https://github.com/ignite/apps/hermes",
"documentationUrl": "https://github.com/ignite/apps/tree/main/hermes/README.md",
"license": {
"name": "MIT",
"url": "github.com/ignite/apps/blob/main/LICENSE"
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"relayer",
Expand All @@ -33,19 +27,5 @@
"supportedPlatforms": [
"mac",
"linux"
],
"socialMedia": {
"x": "",
"telegram": "",
"discord": "",
"reddit": "",
"website": ""
},
"donations": {
"cryptoAddresses": {
"cosmos": "",
"otherSupportedCryptos": ""
},
"fiatDonationLinks": ""
}
]
}
28 changes: 3 additions & 25 deletions _registry/ignite.apps.marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@
"ignite": ">28.0.0",
"dependencies": {},
"cosmosSDK": ">0.50.1",
"features": [
"App Registry",
"App Discovery",
"App Explorer"
],
"wasm": false,
"authors": [
{
"name": "Ehsan Saradar",
Expand All @@ -18,13 +12,11 @@
"github": "Ehsan-saradar"
}
],
"repository": {
"url": "https://github.com/ignite/apps/tree/main/marketplace"
},
"repositoryUrl": "https://github.com/ignite/apps/marketplace",
"documentationUrl": "",
"license": {
"name": "MIT",
"url": "github.com/ignite/apps/blob/main/LICENSE"
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"marketplace",
Expand All @@ -36,19 +28,5 @@
"supportedPlatforms": [
"mac",
"linux"
],
"socialMedia": {
"x": "",
"telegram": "",
"discord": "",
"reddit": "",
"website": ""
},
"donations": {
"cryptoAddresses": {
"cosmos": "",
"otherSupportedCryptos": ""
},
"fiatDonationLinks": ""
}
]
}
28 changes: 4 additions & 24 deletions _registry/ignite.apps.rollkit.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
"ignite": ">28.4.0",
"dependencies": {},
"cosmosSDK": ">0.50.6",
"features": [
"Scaffolder",
"Rollkit"
],
"wasm": false,
"authors": [
{
"name": "Julien Robert",
Expand All @@ -17,15 +12,14 @@
"github": "julienrbrt"
}
],
"repository": {
"url": "https://github.com/ignite/apps/tree/main/rollkit"
},
"repositoryUrl": "https://github.com/ignite/apps/rollkit",
"documentationUrl": "https://github.com/ignite/apps/tree/main/rollkit/README.md",
"license": {
"name": "MIT",
"url": "github.com/ignite/apps/blob/main/LICENSE"
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"scaffolder",
"rollup",
"rollkit",
"cli",
Expand All @@ -35,19 +29,5 @@
"supportedPlatforms": [
"mac",
"linux"
],
"socialMedia": {
"x": "",
"telegram": "",
"discord": "",
"reddit": "",
"website": ""
},
"donations": {
"cryptoAddresses": {
"cosmos": "",
"otherSupportedCryptos": ""
},
"fiatDonationLinks": ""
}
]
}
30 changes: 5 additions & 25 deletions _registry/ignite.apps.wasm.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
"ignite": ">28.3.0",
"dependencies": {},
"cosmosSDK": ">0.50.4",
"features": [
"Scaffolder",
"CosmWasm"
],
"wasm": false,
"authors": [
{
"name": "Danilo Pantani",
Expand All @@ -17,15 +12,14 @@
"github": "pantani"
}
],
"repository": {
"url": "https://github.com/ignite/apps/tree/main/wasm"
},
"documentationUrl": "https://github.com/cosmos/gex",
"repositoryUrl": "https://github.com/ignite/apps/wasm",
"documentationUrl": "https://github.com/ignite/apps/blob/main/wasm/README.md",
"license": {
"name": "MIT",
"url": "github.com/ignite/apps/blob/main/LICENSE"
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"scaffolder",
"wasm",
"cli",
"cosmos-sdk",
Expand All @@ -34,19 +28,5 @@
"supportedPlatforms": [
"mac",
"linux"
],
"socialMedia": {
"x": "",
"telegram": "",
"discord": "",
"reddit": "",
"website": ""
},
"donations": {
"cryptoAddresses": {
"cosmos": "",
"otherSupportedCryptos": ""
},
"fiatDonationLinks": ""
}
]
}
Loading

0 comments on commit 1cae9a8

Please sign in to comment.