Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 2.14 KB

README.md

File metadata and controls

33 lines (20 loc) · 2.14 KB

Ignite App Registry

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

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: 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**

The expected template of the username.repository.app_name.json file can be found here.
Replace each placeholder with the specific details of your app.

Best Practices

  • 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

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.