feat: add apps to registry (#95)

* feat: add apps to registry * updates * feedback Co-authored-by: Danny <[email protected]> --------- Co-authored-by: Danny <[email protected]>
ignite · May 24, 2024 · 2c8e5ff · 2c8e5ff
1 parent 3270b00
commit 2c8e5ff
Show file tree

Hide file tree

Showing 11 changed files with 336 additions and 65 deletions.
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,37 @@
+# Default state for all rules
+default: true
+
+# MD013/line-length: Line length
+# Enabled to enforce line length limits.
+line-length: false
+
+# MD047/single-trailing-newline: Files should end with a single newline character
+single-trailing-newline: true
+
+# MD025/single-title/single-h1: Multiple top-level headings in the same document
+# Allows for metadata and an H1 in the same document.
+single-title: false
+
+# MD032/blanks-around-lists: Blanks around lists
+# Requires blank lines around lists for clarity.
+blanks-around-lists: true
+
+# MD036/no-emphasis-as-heading: No emphasis as heading
+# Prevents using emphasis in place of headings.
+no-emphasis-as-heading: true
+
+# MD040/fenced-code-language: Fenced code blocks should have a language specified
+# Encourages specifying languages in code blocks for syntax highlighting.
+fenced-code-language: true
+
+# MD026/no-trailing-punctuation: No trailing punctuation in headings
+# Avoids trailing punctuation in headings.
+no-trailing-punctuation: true
+
+# MD022/blanks-around-headings: Blanks around headings
+# Ensures there is at least one blank line above and below headings.
+blanks-around-headings: true
+
+# MD031/blanks-around-fences: Blanks around fenced code blocks
+# Requires at least one blank line before and after fenced code blocks.
+blanks-around-fences: true
diff --git a/_ignite-app-registry/explorer/app.json b/_ignite-app-registry/explorer/app.json
diff --git a/_ignite-app-registry/README.md → _registry/README.md b/_ignite-app-registry/README.md → _registry/README.md
@@ -1,21 +1,21 @@
-# **Ignite App Registry**
+# Ignite App Registry
 
-## **Overview**
+## Overview
 
 The Ignite App Registry is a directory designed to catalog applications built within the Ignite Apps ecosystem. It aims to facilitate discovery, collaboration, and information sharing among developers and users. By submitting your app to the registry, you make it easier for the community to learn about and engage with your project.
 
-## **How to Add Your Ignite App**
+## How to Add Your Ignite App
 
 To add your app to the Ignite App Registry, follow these steps:
 
 1. **Fork the Repository**: Start by forking the `ignite/apps` repository to your own GitHub account.
-2. **Set Up Your App Directory**: Inside the repository and inside the directory `_ignite_app_registry`, create a new directory named after your app. Ensure the name is unique and descriptive.
-3. **Configure Your App**: In your app's directory, add an `app.json` file. This file should contain all the relevant details about your app according to the template provided below.
-4. **Submit a Pull Request**: Once you've added your app's directory and `app.json` file, submit a pull request to the original `ignite/apps` repository. Your pull request will be reviewed by the  maintainers, and once approved, your app will be listed in the registry.
+2. **Set Up Your App Directory**: Within the `_registry` directory of the repository, create a JSON file named using the following format: `username.repository.app_name.json`. Use your GitHub username, repository name, and app name to complete the filename.
+3. **Configure Your App**: Populate the previously created file with all the necessary details about your app, following the template provided below.
+4. **Submit a Pull Request**: Once the above steps are completed, submit a pull request to the original `ignite/apps` repository. Your pull request will be reviewed by the maintainers, and once approved, your app will be listed in the registry.
 
 ## `app.json` File Structure**
 
-Below is the template for the `app.json` file. Replace each placeholder with the specific details of your app.
+Below is the template for the `username.repository.app_name.json` file. Replace each placeholder with the specific details of your app.
 
 ```json
 {
@@ -66,16 +66,16 @@ Below is the template for the `app.json` file. Replace each placeholder with the
 }
 ```
 
-## **Best Practices**
+## Best Practices
 
-- **Keep Information Up-to-Date**: Regularly update your `app.json` file to reflect the latest releases, compatibility changes, and other relevant information.
+- **Keep Information Up-to-Date**: Regularly update your app JSON file to reflect the latest releases, compatibility changes, and other relevant information.
 - **Detailed Descriptions**: Provide clear and concise descriptions of your app's features and functionality.
 - **Engage with the Community**: Participate in discussions, address issues, and provide support to encourage engagement with your app.
 
-## **Support and Contributions**
+## Support and Contributions
 
 The Ignite App Registry is a community-driven project. We welcome contributions, suggestions, and feedback. If you encounter issues or have ideas for improving the registry, please open an issue or submit a pull request.
 
 ## Disclaimer
 
-Inclusion in the registry is not an official endorsement or recognition.
+Inclusion in the registry is not an official endorsement or recognition.
diff --git a/_registry/ignite.apps.explorer.json b/_registry/ignite.apps.explorer.json
@@ -0,0 +1,54 @@
+{
+  "appName": "explorer",
+  "appDescription": "Shows real time feed of your blockchain",
+  "ignite": ">28.3.0",
+  "dependencies": {
+    "docker": ">23.0.5"
+  },
+  "cosmosSDK": ">0.50.4",
+  "features": [
+    "CLI Explorer",
+    "Gex"
+  ],
+  "wasm": false,
+  "authors": [
+    {
+      "name": "Jeronimo Albi",
+      "email": "",
+      "website": "",
+      "github": "jeronimoalbi"
+    }
+  ],
+  "repository": {
+    "url": "https://github.com/ignite/apps/tree/main/explorer"
+  },
+  "documentationUrl": "https://github.com/cosmos/gex",
+  "license": {
+    "name": "MIT",
+    "url": "github.com/username/app/LICENSE.md"
+  },
+  "keywords": [
+    "explorer",
+    "cli",
+    "cosmos-sdk",
+    "ignite app"
+  ],
+  "supportedPlatforms": [
+    "mac",
+    "linux"
+  ],
+  "socialMedia": {
+    "x": "",
+    "telegram": "",
+    "discord": "",
+    "reddit": "",
+    "website": ""
+  },
+  "donations": {
+    "cryptoAddresses": {
+      "cosmos": "",
+      "otherSupportedCryptos": ""
+    },
+    "fiatDonationLinks": ""
+  }
+}
diff --git a/_registry/ignite.apps.hermes.json b/_registry/ignite.apps.hermes.json
@@ -0,0 +1,51 @@
+{
+  "appName": "hermes",
+  "appDescription": "A wrapper around the hermes IBC relayer",
+  "ignite": ">0.27.0",
+  "dependencies": {},
+  "cosmosSDK": ">0.50.1",
+  "features": [
+    "IBC relayer"
+  ],
+  "wasm": false,
+  "authors": [
+    {
+      "name": "Danilo Pantani",
+      "email": "",
+      "website": "",
+      "github": "pantani"
+    }
+  ],
+  "repository": {
+    "url": "https://github.com/ignite/apps/tree/main/hermes"
+  },
+  "documentationUrl": "https://github.com/ignite/apps/tree/main/hermes/README.md",
+  "license": {
+    "name": "MIT",
+    "url": "github.com/ignite/apps/blob/main/LICENSE"
+  },
+  "keywords": [
+    "relayer",
+    "cli",
+    "cosmos-sdk",
+    "ignite app"
+  ],
+  "supportedPlatforms": [
+    "mac",
+    "linux"
+  ],
+  "socialMedia": {
+    "x": "",
+    "telegram": "",
+    "discord": "",
+    "reddit": "",
+    "website": ""
+  },
+  "donations": {
+    "cryptoAddresses": {
+      "cosmos": "",
+      "otherSupportedCryptos": ""
+    },
+    "fiatDonationLinks": ""
+  }
+}
diff --git a/_registry/ignite.apps.marketplace.json b/_registry/ignite.apps.marketplace.json
@@ -0,0 +1,54 @@
+{
+  "appName": "marketplace",
+  "appDescription": "Explore the world of Ignite applications and more!",
+  "ignite": ">28.0.0",
+  "dependencies": {},
+  "cosmosSDK": ">0.50.1",
+  "features": [
+    "App Registry",
+    "App Discovery",
+    "App Explorer"
+  ],
+  "wasm": false,
+  "authors": [
+    {
+      "name": "Ehsan Saradar",
+      "email": "",
+      "website": "",
+      "github": "Ehsan-saradar"
+    }
+  ],
+  "repository": {
+    "url": "https://github.com/ignite/apps/tree/main/marketplace"
+  },
+  "documentationUrl": "",
+  "license": {
+    "name": "MIT",
+    "url": "github.com/ignite/apps/blob/main/LICENSE"
+  },
+  "keywords": [
+    "marketplace",
+    "registry",
+    "cli",
+    "cosmos-sdk",
+    "ignite app"
+  ],
+  "supportedPlatforms": [
+    "mac",
+    "linux"
+  ],
+  "socialMedia": {
+    "x": "",
+    "telegram": "",
+    "discord": "",
+    "reddit": "",
+    "website": ""
+  },
+  "donations": {
+    "cryptoAddresses": {
+      "cosmos": "",
+      "otherSupportedCryptos": ""
+    },
+    "fiatDonationLinks": ""
+  }
+}
diff --git a/_registry/ignite.apps.rollkit.json b/_registry/ignite.apps.rollkit.json
@@ -0,0 +1,53 @@
+{
+  "appName": "rollkit",
+  "appDescription": "Scaffold a RollKit application with ease",
+  "ignite": ">28.4.0",
+  "dependencies": {},
+  "cosmosSDK": ">0.50.6",
+  "features": [
+    "Scaffolder",
+    "Rollkit"
+  ],
+  "wasm": false,
+  "authors": [
+    {
+      "name": "Julien Robert",
+      "email": "",
+      "website": "",
+      "github": "julienrbrt"
+    }
+  ],
+  "repository": {
+    "url": "https://github.com/ignite/apps/tree/main/rollkit"
+  },
+  "documentationUrl": "https://github.com/ignite/apps/tree/main/rollkit/README.md",
+  "license": {
+    "name": "MIT",
+    "url": "github.com/ignite/apps/blob/main/LICENSE"
+  },
+  "keywords": [
+    "rollup",
+    "rollkit",
+    "cli",
+    "cosmos-sdk",
+    "ignite app"
+  ],
+  "supportedPlatforms": [
+    "mac",
+    "linux"
+  ],
+  "socialMedia": {
+    "x": "",
+    "telegram": "",
+    "discord": "",
+    "reddit": "",
+    "website": ""
+  },
+  "donations": {
+    "cryptoAddresses": {
+      "cosmos": "",
+      "otherSupportedCryptos": ""
+    },
+    "fiatDonationLinks": ""
+  }
+}