|
|
|
@@ -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
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
The final technology stack is being determined. The planned stack is as follows:
|
|
|
|
|
|
|
|
|
|
| Layer | Technology |
|
|
|
|
|
| :--- | :--- |
|
|
|
|
|
| Language | — |
|
|
|
|
|
| Framework | — |
|
|
|
|
|
| Key Dependencies | — |
|
|
|
|
|
| Language | JavaScript |
|
|
|
|
|
| Framework | None (Standard Library + Minimal 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
|
|
|
|
|
|
|
|
|
|
- Docker & Docker Compose
|
|
|
|
|
- Node.js / Python (specify version)
|
|
|
|
|
- Node.js 18+
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
|
|
|
|
|
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-node.git
|
|
|
|
|
|
|
|
|
|
# Copy environment variables
|
|
|
|
|
cp .env.example .env
|
|
|
|
|
cd evercatch-node
|
|
|
|
|
|
|
|
|
|
# Start services
|
|
|
|
|
docker compose up -d
|
|
|
|
|
# Note: The project is not yet functional.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|