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

Refers Evercatch/evercatch-board#21
This commit is contained in:
2026-02-18 16:29:36 +00:00
parent b3cd9ca334
commit 32d170decc
3 changed files with 43 additions and 14 deletions

View File

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

3
index.js Normal file
View File

@@ -0,0 +1,3 @@
console.log("Evercatch SDK - Coming Soon");
console.log("Visit https://evercatch.dev for updates");
module.exports = {};

16
package.json Normal file
View File

@@ -0,0 +1,16 @@
{
"name": "@evercatch/sdk",
"version": "0.0.1",
"description": "Evercatch SDK for Node.js/TypeScript (Coming Soon)",
"main": "index.js",
"author": "Evercatch <npm@evercatch.dev>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://git.psmattas.com/evercatch/evercatch-node"
},
"keywords": ["evercatch", "webhooks", "sdk"],
"engines": {
"node": ">=16"
}
}