An open API service indexing awesome lists of open source software.

https://github.com/studiowebux/cardano-indexer

Cardano Indexer built with Deno and Ogmios; runs with Kafka and MongoDB
https://github.com/studiowebux/cardano-indexer

cardano deno indexer kafka mongodb

Last synced: 5 months ago
JSON representation

Cardano Indexer built with Deno and Ogmios; runs with Kafka and MongoDB

Awesome Lists containing this project

README

          

Cardano Indexer

A Cardano event-driven indexer, implemented in Deno and built upon the Ogmios solution.


Report Bug
·
Request Feature


---

## About

- **Indexer:** Developed using Ogmios and Deno, this Cardano indexer serves as
the core of our project.
- **Message Transfer:** We employ Apache Kafka for efficient communication
between the indexer and processor components.
- **Data Storage:** MongoDB is utilized to store block data and other relevant
information, ensuring flexibility and swift adjustments based on custom
requirements.
- **API & Dashboard:** Hono facilitates a straightforward API, while HTMX
enables creation of a basic yet functional dashboard.
- **Monitoring:** Prometheus is integrated for comprehensive tracking of metrics
and ensuring smooth project operation.

**Documentation:** https://cardano.studiowebux.com

---

## Contributing

1. Fork the project
2. Create a Feature Branch
3. Commit your changes
4. Push your changes
5. Create a PR

Working with your local branch

**Branch Checkout:**

```bash
git checkout -b /prefix-name
```

> Your branch name must starts with [feature|fix|release|chore|hotfix] and use a
> / before the name; Use hyphens as separator; The prefix correspond to your
> Kanban tool id (e.g. abc-123)

**Keep your branch synced:**

```bash
git fetch origin
git rebase origin/master
```

**Commit your changes:**

```bash
git add .
git commit -m ": commit message"
```

> Follow this convention commitlint for your commit message structure

**Push your changes:**

```bash
git push origin /prefix-name
```

**Examples:**

```bash
git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix
```

```bash
git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"
```

## License

Distributed under the MIT License. See LICENSE for more information.

## Contact

- Tommy Gingras @ tommy@studiowebux.com | Studio Webux


|
Buy Me A Coffee
|
Webux Logo Webux Lab
|