Compare commits
8 Commits
b3cd9ca334
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
7d3b416531
|
|||
|
2e92d5d5a8
|
|||
|
91b558197b
|
|||
|
8cb6f56947
|
|||
|
9e1c4d0b1a
|
|||
|
c80250e4c2
|
|||
|
85e9aa9b06
|
|||
|
32d170decc
|
22
.npmignore
Normal file
22
.npmignore
Normal file
@@ -0,0 +1,22 @@
|
||||
# .npmignore
|
||||
|
||||
# Ignore Gitea/Git configurations
|
||||
.gitea/
|
||||
.git/
|
||||
.gitignore
|
||||
|
||||
# Ignore Environment/Config files
|
||||
.env
|
||||
.env.example
|
||||
|
||||
# Ignore Maintenance & Repo Management files
|
||||
# (Users installing the package usually don't need these)
|
||||
CODEOWNERS
|
||||
CONTRIBUTING.md
|
||||
SECURITY.md
|
||||
|
||||
# Ignore Logs
|
||||
npm-debug.log
|
||||
*.log
|
||||
|
||||
# Note: NEVER ignore package.json, README.md, LICENSE, or your actual code (index.js)
|
||||
6
.npmrc
Normal file
6
.npmrc
Normal file
@@ -0,0 +1,6 @@
|
||||
# .npmrc
|
||||
# 1. Tell npm that @evercatch packages live on your server
|
||||
@evercatch:registry=https://git.psmattas.com/api/packages/Evercatch/npm/
|
||||
|
||||
# 2. Setup Auth using an Environment Variable
|
||||
//git.psmattas.com/api/packages/Evercatch/npm/:_authToken=${GITEA_TOKEN}
|
||||
13
CHANGELOG.md
Normal file
13
CHANGELOG.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [0.0.2] - 2026-02-20
|
||||
### Added
|
||||
- Initial release of the SDK.
|
||||
- Added `.npmignore` to exclude Gitea config files.
|
||||
- Configured dual publishing (Gitea + Public NPM).
|
||||
|
||||
## [0.0.1] - 2026-02-18
|
||||
### Added
|
||||
- Project initialization.
|
||||
25
LICENSE
25
LICENSE
@@ -1,8 +1,21 @@
|
||||
Copyright (c) 2026 Evercatch. All rights reserved.
|
||||
MIT License
|
||||
|
||||
This software and its source code are proprietary and confidential.
|
||||
Unauthorised copying, distribution, modification, or use of this software,
|
||||
in whole or in part, via any medium, is strictly prohibited without the
|
||||
prior written permission of Evercatch.
|
||||
Copyright (c) 2026 Evercatch
|
||||
|
||||
For licensing enquiries, contact: legal@evercatch.io
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
38
README.md
38
README.md
@@ -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/sdk
|
||||
```
|
||||
|
||||
### 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.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
3
index.js
Normal file
3
index.js
Normal file
@@ -0,0 +1,3 @@
|
||||
console.log("Evercatch SDK - Coming Soon");
|
||||
console.log("Visit https://evercatch.dev for updates");
|
||||
module.exports = {};
|
||||
2302
package-lock.json
generated
Normal file
2302
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
29
package.json
Normal file
29
package.json
Normal file
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"name": "@evercatch/sdk",
|
||||
"version": "0.0.2",
|
||||
"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"
|
||||
},
|
||||
"scripts": {
|
||||
"release": "commit-and-tag-version",
|
||||
"publish:gitea": "npm publish",
|
||||
"publish:public": "npm publish --@evercatch:registry=https://registry.npmjs.org --access public",
|
||||
"publish:all": "npm run publish:gitea && npm run publish:public"
|
||||
},
|
||||
"devDependencies": {
|
||||
"commit-and-tag-version": "^12.6.1"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user