Merge branch 'EC-21-Official-SDKs'
Refers: Evercatch/evercatch-board#21
This commit was merged in pull request #1.
This commit is contained in:
38
README.md
38
README.md
@@ -1,22 +1,26 @@
|
|||||||
# 📦 Repository Name
|
# 📦 Evercatch PHP
|
||||||
|
|
||||||
> Short one-line description of what this repository does.
|
> Official PHP 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 PHP 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 PHP applications.
|
||||||
|
|
||||||
|
**⚠️ This SDK is currently under active development and is not yet ready for production use. The package published on Packagist 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 | PHP |
|
||||||
| Framework | — |
|
| Framework | None (Standard Library + Minimal Dependencies) |
|
||||||
| Key Dependencies | — |
|
| Key Dependencies | `curl` or `guzzle` (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
|
- PHP 8.0+
|
||||||
- Node.js / Python (specify version)
|
|
||||||
|
### Installation (Future)
|
||||||
|
|
||||||
|
Once released, the package will be available on Packagist:
|
||||||
|
```bash
|
||||||
|
# This will not work until the first official release
|
||||||
|
composer require 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-php.git
|
||||||
cd REPO_NAME
|
|
||||||
|
|
||||||
# Copy environment variables
|
cd evercatch-php
|
||||||
cp .env.example .env
|
|
||||||
|
|
||||||
# Start services
|
# Note: The project is not yet functional.
|
||||||
docker compose up -d
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
20
composer.json
Normal file
20
composer.json
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
{
|
||||||
|
"name": "evercatch/evercatch-php",
|
||||||
|
"description": "Evercatch SDK for PHP (Coming Soon)",
|
||||||
|
"type": "library",
|
||||||
|
"license": "MIT",
|
||||||
|
"authors": [
|
||||||
|
{
|
||||||
|
"name": "Evercatch",
|
||||||
|
"email": "support@evercatch.dev"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"require": {
|
||||||
|
"php": ">=8.0"
|
||||||
|
},
|
||||||
|
"autoload": {
|
||||||
|
"psr-4": {
|
||||||
|
"Evercatch\": "src/"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
11
src/Client.php
Normal file
11
src/Client.php
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
<?php
|
||||||
|
namespace Evercatch;
|
||||||
|
|
||||||
|
// Coming Soon
|
||||||
|
// Official PHP SDK for Evercatch
|
||||||
|
// Expected launch: Q2 2026
|
||||||
|
// Visit https://evercatch.dev
|
||||||
|
|
||||||
|
class Client {
|
||||||
|
const VERSION = '0.0.1';
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user