EC-21: FEAT: Added new Ruby package and initialized the repo
All checks were successful
PR Management Bot / pr-bot (pull_request) Successful in 7s
PR Title Checker / Validate PR Title Format (pull_request) Successful in 2s

Refers Evercatch/evercatch-board#21
This commit is contained in:
2026-02-19 19:47:44 +00:00
parent 6411883f58
commit 460c332d39
4 changed files with 48 additions and 14 deletions

View File

@@ -1,22 +1,26 @@
# 📦 Repository Name
# 📦 Evercatch Ruby
> Short one-line description of what this repository does.
> Official Ruby SDK for Evercatch webhook infrastructure platform.
---
## 🧭 Overview
Describe what this service/module is responsible for within the Evercatch platform.
This repository contains the official Ruby SDK for the Evercatch platform. Its purpose is to provide a simple and convenient interface for developers to interact with the Evercatch API, manage webhooks, and handle events within their Ruby applications.
**⚠️ This SDK is currently under active development and is not yet ready for production use. The package published on RubyGems is a placeholder to reserve the name.**
---
## 🛠️ Tech Stack
The final technology stack is being determined. The planned stack is as follows:
| Layer | Technology |
| :--- | :--- |
| Language | |
| Framework | |
| Key Dependencies | |
| Language | Ruby |
| Framework | None (Standard Library + Minimal Dependencies) |
| Key Dependencies | `httparty` or `net/http` (for HTTP), `Zod` (for data models) |
---
@@ -24,21 +28,27 @@ Describe what this service/module is responsible for within the Evercatch platfo
### Prerequisites
- Docker & Docker Compose
- Node.js / Python (specify version)
- Ruby 2.7+
### Installation (Future)
Once released, the package will be available on RubyGems:
```bash
# This will not work until the first official release
gem install evercatch
```
### Local Development
The repository can be cloned for contribution or testing once development is further along.
```bash
# Clone the repo
git clone https://git.psmattas.com/Evercatch/REPO_NAME.git
cd REPO_NAME
git clone https://git.psmattas.com/Evercatch/evercatch-ruby.git
# Copy environment variables
cp .env.example .env
cd evercatch-ruby
# Start services
docker compose up -d
# Note: The project is not yet functional.
```
---