Skip to content

Commit

Permalink
Merge branch 'main' into julien/connect
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt committed Jan 23, 2025
2 parents 902f0a8 + 9906666 commit 6415ad8
Show file tree
Hide file tree
Showing 290 changed files with 38,308 additions and 4,237 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
cca/templates/web linguist-generated=true
3 changes: 1 addition & 2 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ linters:
enable:
- bodyclose
- decorder
#- depguard
- depguard
- dogsled
- dupword
- errchkjson
Expand All @@ -25,7 +25,6 @@ linters:
- misspell
- nakedret
- nolintlint
- exportloopref
- staticcheck
- reassign
- stylecheck
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ govulncheck:
lint:
@command -v golangci-lint >/dev/null 2>&1 || { \
echo "Installing golangci-lint..."; \
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.56.2; \
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.60.3; \
}
@echo Running golangci-lint...
@for dir in $$(find $$(pwd -P) -mindepth 1 -maxdepth 4 -type d); do \
Expand All @@ -65,7 +65,7 @@ lint:
lint-ci:
@command -v golangci-lint >/dev/null 2>&1 || { \
echo "Installing golangci-lint..."; \
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.56.2; \
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.60.3; \
}
@echo Running golangci-lint...
@for dir in $$(find $$(pwd -P) -mindepth 1 -maxdepth 4 -type d); do \
Expand Down
49 changes: 32 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# **Ignite Apps**
# Ignite Apps

Welcome to the Ignite App repository, a hub for enhancing blockchain app development with Ignite CLI. Our goal is to provide a platform where developers can find and share tools and insights, making blockchain application development more efficient and insightful.

## **About Ignite Apps**
## About Ignite Apps

Ignite Apps aims to extend the functionality of Ignite CLI, offering both official and community-contributed integrations. These integrations are designed to streamline development processes and offer valuable insights for blockchain app developers.

### **Official Ignite Apps**
### Official Ignite Apps

- Developed by the core Ignite engineering team.
- Rigorously tested and fully supported.
- To submit your community-built app for official inclusion, please follow our submission guidelines.

## **Getting Started**
## Getting Started

### **How to Install an App**
### How to Install an App

```bash
ignite app install -g github.com/ignite/apps/[app-name]
Expand All @@ -28,7 +28,7 @@ ignite app install -g github.com/ignite/apps/hermes

For more details, see [Installing Ignite Apps](https://docs.ignite.com/apps/using-apps).

### **How to Create an App**
### How to Create an App

Scaffold your Ignite app with one simple command:

Expand All @@ -44,7 +44,7 @@ ignite app install -g path/to/your/app

For more information, refer to [Creating Ignite Apps](https://docs.ignite.com/apps/developing-apps).

## **Contributing**
## Contributing

We welcome and appreciate new contributions. If you have an idea or an app that can benefit Ignite users, please follow our contribution guidelines.

Expand All @@ -56,19 +56,34 @@ We welcome and appreciate new contributions. If you have an idea or an app that

For detailed contribution guidelines, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

## **Repository Structure**
## Repository Structure

Each directory in the root of this repository is a Go module containing an Ignite App package, with each app having its own go.mod file. This structure ensures modularity and ease of management for each app within the Ignite ecosystem.
Each directory in the root of this repository is a Go module containing an Ignite App package, with each app having its own go.mod file.
This structure ensures modularity and ease of management for each app within the Ignite ecosystem.

## **Support and Feedback**
app-name/
├── cmd/
│ └── command_one.go
│ └── command_two.go
├── integration/
│ └── app_test.go
├── changelog.md
├── go.mod
├── go.sum
├── main.go
└── README.md

The actual implementation of the app is in the root directory, while the `cmd` directory contains the commands that are exposed to the user.

## Support and Feedback

For support, questions, or feedback, please open an issue in this repository.

### **Community Build Apps**
### Community Build Apps

The Ignite Apps ecosystem thrives on community contributions, offering a space for developers to share, showcase, and collaborate on Ignite integrations. If you've built an app that leverages Ignite CLI and wish to share it with the community, we encourage you to do so by following these guidelines:

### **Create Your Repository**
### Create Your Repository

1. **Setup Your Project:** Begin by creating a new repository for your project on GitHub. This repository will host your app's code, documentation, and other relevant materials.
2. **Choose a License:** Choosing an appropriate license for your project is essential. This ensures that others know how they can legally use, modify, and distribute your app. GitHub's licensing guide can help you decide which license to use if you're unsure.
Expand All @@ -78,15 +93,15 @@ The Ignite Apps ecosystem thrives on community contributions, offering a space f
- Usage examples to help users get started quickly.
- Contribution guidelines if you're open to receiving contributions from others.

### **Integrate with the Ignite App Registry**
### Integrate with the Ignite App Registry

Once your repository is set up and ready to be shared, we invite you to add your app to the Ignite App Registry. This registry is a curated list of community-built apps, making it easier for users to discover and utilize your contributions.

1. **Fork the App-Registry Repository:** Visit the Ignite App-Registry repository and fork it to your GitHub account.
2. **Add Your App:** In your fork, add a new entry for your app in the registry. This should include the name of your app, a brief description, and a link to your app's repository.
3. **Submit a Pull Request:** Once you've added your app to the registry, submit a pull request to the original App-Registry repository. Our team will review your submission and, if everything is in order, merge it into the registry.

### **Engage with the Community**
### Engage with the Community

Sharing your app is just the beginning. Engage with the Ignite community by:

Expand All @@ -96,11 +111,11 @@ Sharing your app is just the beginning. Engage with the Ignite community by:

We're excited to see your contributions and how they will enrich the Ignite Apps ecosystem. Together, we can build a diverse and vibrant community of blockchain application developers.

## **License**
## License

This project is licensed under the [Copyright License](LICENSE) - see the [LICENSE](LICENSE) file for details.

## **Community**
## Community

- Join the community conversations on [Discord](https://discord.com/invite/ignite) or [X/Twitter](https://twitter.com/ignite).
- Follow the project's progress and updates.
Expand All @@ -112,4 +127,4 @@ This project is licensed under the [Copyright License](LICENSE) - see the [LICEN
- Add the folder to the `go.work`.
- Add your cobra commands into `debug/main.go` and the module replace to the `debug/go.mod` for a easy debug.
- Add the plugin: `ignite app add -g ($GOPATH)/src/github.com/ignite/apps/my-app`
- Test with Ignite.
- Test with Ignite.
11 changes: 7 additions & 4 deletions _registry/ignite.apps.appregistry.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"appName": "appregistry",
"appName": "App Registry",
"slug": "appregistry",
"appDescription": "Explore the world of Ignite applications and more!",
"ignite": ">28.0.0",
"dependencies": {},
Expand All @@ -14,8 +15,8 @@
"github": "julienrbrt"
}
],
"repositoryUrl": "https://github.com/ignite/apps",
"documentationUrl": "https://github.com/ignite/apps/tree/main/appregistry/README.md",
"repositoryUrl": "https://github.com/ignite/apps/appregistry",
"documentationUrl": "https://github.com/ignite/apps/blob/main/appregistry/README.md",
"license": {
"name": "MIT",
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
Expand All @@ -30,5 +31,7 @@
"supportedPlatforms": [
"mac",
"linux"
]
],
"icon": "",
"cover": ""
}
35 changes: 35 additions & 0 deletions _registry/ignite.apps.cca.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"appName": "CCA",
"slug": "cca",
"appDescription": "Scaffold a blockchain frontend in seconds with Ignite",
"ignite": ">28.7.0",
"dependencies": {},
"cosmosSDK": ">0.50.1",
"authors": [
{
"name": "Julien Robert",
"github": "julienrbrt"
}
],
"repositoryUrl": "https://github.com/ignite/apps",
"documentationUrl": "https://github.com/ignite/apps/tree/main/cca/README.md",
"license": {
"name": "MIT",
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"cca",
"create-cosmos-app",
"telescope",
"cosmjs",
"interchain-js",
"cosmology",
"cli",
"cosmos-sdk",
"ignite app"
],
"supportedPlatforms": [
"mac",
"linux"
]
}
34 changes: 34 additions & 0 deletions _registry/ignite.apps.consumer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"appName": "Consumer",
"slug": "consumer",
"appDescription": "Internal Ignite App for scaffolding consumer chains (not to be installed manually)",
"ignite": ">28.3.0",
"dependencies": {
"docker": ">23.0.5"
},
"cosmosSDK": ">0.50.4",
"authors": [
{
"name": "Julien Robert",
"github": "julienrbrt"
}
],
"repositoryUrl": "https://github.com/ignite/apps/consumer",
"documentationUrl": "https://github.com/ignite/apps/blob/main/consumer/README.md",
"license": {
"name": "MIT",
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"consumer",
"cli",
"cosmos-sdk",
"ignite app"
],
"supportedPlatforms": [
"mac",
"linux"
],
"icon": "",
"cover": ""
}
39 changes: 39 additions & 0 deletions _registry/ignite.apps.example-chain-info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"appName": "Chain Info (example)",
"slug": "example-chain-info",
"appDescription": "A simple chain information application",
"ignite": ">28.3.0",
"dependencies": {
"docker": ">23.0.5"
},
"cosmosSDK": ">0.50.4",
"authors": [
{
"name": "Ehsan Saradar",
"github": "Ehsan-saradar"
},
{
"name": "Danilo Pantani",
"github": "Pantani"
}
],
"repositoryUrl": "https://github.com/ignite/apps/examples/chain-info",
"documentationUrl": "https://github.com/ignite/apps/blob/main/examples/chain-info/README.md",
"license": {
"name": "MIT",
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"chain-info",
"example",
"cli",
"cosmos-sdk",
"ignite app"
],
"supportedPlatforms": [
"mac",
"linux"
],
"icon": "",
"cover": ""
}
39 changes: 39 additions & 0 deletions _registry/ignite.apps.example-flags.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"appName": "Flags (example)",
"slug": "example-flags",
"appDescription": "A simple flags usage application",
"ignite": ">28.3.0",
"dependencies": {
"docker": ">23.0.5"
},
"cosmosSDK": ">0.50.4",
"authors": [
{
"name": "Ehsan Saradar",
"github": "Ehsan-saradar"
},
{
"name": "Danilo Pantani",
"github": "Pantani"
}
],
"repositoryUrl": "https://github.com/ignite/apps/examples/flags",
"documentationUrl": "https://github.com/ignite/apps/blob/main/examples/flags/README.md",
"license": {
"name": "MIT",
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"flags",
"example",
"cli",
"cosmos-sdk",
"ignite app"
],
"supportedPlatforms": [
"mac",
"linux"
],
"icon": "",
"cover": ""
}
39 changes: 39 additions & 0 deletions _registry/ignite.apps.example-health-monitor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"appName": "Health Monitor (example)",
"slug": "example-health-monitor",
"appDescription": "A simple health monitor application",
"ignite": ">28.3.0",
"dependencies": {
"docker": ">23.0.5"
},
"cosmosSDK": ">0.50.4",
"authors": [
{
"name": "Ehsan Saradar",
"github": "Ehsan-saradar"
},
{
"name": "Danilo Pantani",
"github": "Pantani"
}
],
"repositoryUrl": "https://github.com/ignite/apps/examples/health-monitor",
"documentationUrl": "https://github.com/ignite/apps/blob/main/examples/health-monitor/README.md",
"license": {
"name": "MIT",
"url": "https://github.com/ignite/apps/blob/main/LICENSE"
},
"keywords": [
"health-monitor",
"example",
"cli",
"cosmos-sdk",
"ignite app"
],
"supportedPlatforms": [
"mac",
"linux"
],
"icon": "",
"cover": ""
}
Loading

0 comments on commit 6415ad8

Please sign in to comment.