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 app-registry initial #65

Merged
merged 6 commits into from
Apr 16, 2024
Merged

feat: Add app-registry initial #65

merged 6 commits into from
Apr 16, 2024

Conversation

toschdev
Copy link
Contributor

@toschdev toschdev commented Feb 27, 2024

Adds the App Registry within ignite/apps/_ignite-app-registry directory. With an example for the explorer Ignite App.

It's expected that in the _ignite-app-registry, each app has it's own directory with an including app.json in the format: appname/app.json.

Here's the schema.app.json:

{
    "appName": "Your App Name",
    "appDescription": "A brief description of what your app does.",
    "latestRelease": {
      "version": "x.y.z",
      "date": "YYYY-MM-DD",
      "releaseNotesUrl": "URL to the release notes or changelog"
    },
    "igniteCompatibility": {
      "lastTestedVersion": "ignite vX.Y.Z"
    },
    "cosmosSdkCompatibility": {
      "lastWorkedVersion": "vX.Y.Z"
    },
    "features": [
      "Feature 1",
      "Feature 2",
      "Additional features..."
    ],
    "wasm": "Indicate if your app uses wasm (yes/no)",
    "authors": [
      {
        "name": "Author Name",
        "email": "email@example.com",
        "website": "Optional author or company website"
      }
    ],
    "repository": {
      "url": "URL to the app's repository",
      "type": "e.g., GitHub, GitLab"
    },
    "documentationUrl": "URL to the app's documentation",
    "license": "License type, e.g., MIT, Apache 2.0",
    "keywords": ["keyword1", "keyword2", "Useful for search and categorization"],
    "supportedPlatforms": ["platform1", "platform2", "e.g., osmosis, cosmoshub"],
    "socialMedia": {
      "twitter": "Optional Twitter handle",
      "telegram": "Optional Telegram group",
      "discord": "Optional Discord server",
      "reddit": "Optional Reddit page"
    },
    "donations": {
      "cryptoAddresses": {
        "cosmos": "cosmos1...",
        "otherSupportedCryptos": "address"
      },
      "fiatDonationLinks": "URL to Patreon, Ko-fi, etc."
    }
}

@toschdev toschdev changed the title Add app-registry initial feat: Add app-registry initial Feb 27, 2024
julienrbrt
julienrbrt previously approved these changes Feb 27, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm, just some suggestions but feel free to dismiss

_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/explorer/app.json Outdated Show resolved Hide resolved
Copy link
Member

@salmad3 salmad3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great @toschdev, left some suggestions, primarily nits and enhancements.

_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
@jeronimoalbi jeronimoalbi mentioned this pull request Mar 4, 2024
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/explorer/app.json Show resolved Hide resolved
_ignite-app-registry/explorer/app.json Outdated Show resolved Hide resolved
@toschdev
Copy link
Contributor Author

toschdev commented Mar 4, 2024

Thanks for all the comments, will try to address them. I really prefer commit suggestions because these are a lot of ideas to unpack.

@github-actions github-actions bot added the ci label Mar 19, 2024
@jeronimoalbi
Copy link
Member

jeronimoalbi commented Mar 20, 2024

Thanks for all the comments, will try to address them. I really prefer commit suggestions because these are a lot of ideas to unpack.

Adding a couple more, just for the record :)

I would not use folders for the different app schemas unless we would have extra files per app, like pictures or documents, which might be better to avoid. That means all app schemas would be available at the same level under ./_ignite-app-registry. Each app schema could follow the naming foo_nam.app.json (or YAML?).

An alternative name for schema.app.json could be registry.json. That would signal to use the .app.json suffix only for app schemas.

If we decide on the JSON schema idea we could defined the JSON schema as schema.json, so we would have registry.json and schema.json

I would keep the schema as simple as possible with the minimum set of features we know are useful right now and maybe I would introduce more features "on demand" or as they are required.

Inspiration could be found in other well stablished schemas:

Nit: Maybe we could just use registry for the folder name instead of _ignite-app-registry so the URL is more semantic https://github.com/ignite/apps/registry

_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
_ignite-app-registry/README.md Outdated Show resolved Hide resolved
_ignite-app-registry/README.md Show resolved Hide resolved
Co-authored-by: Danny <salman.danny03@hotmail.com>
@toschdev toschdev requested a review from salmad3 April 2, 2024 06:16
@salmad3
Copy link
Member

salmad3 commented Apr 15, 2024

@jeronimoalbi @Pantani @julienrbrt bumping again, please re-review so that we can add the initial version.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. we probably can always increment on this later.

@toschdev toschdev merged commit 3f862b9 into main Apr 16, 2024
16 checks passed
@toschdev toschdev deleted the feat/app-registry branch April 16, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants