Initial commit
This commit is contained in:
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# 📦 Repository Name
|
||||
|
||||
> Short one-line description of what this repository does.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Overview
|
||||
|
||||
Describe what this service/module is responsible for within the Evercatch platform.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
| :--- | :--- |
|
||||
| Language | — |
|
||||
| Framework | — |
|
||||
| Key Dependencies | — |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Docker & Docker Compose
|
||||
- Node.js / Python (specify version)
|
||||
|
||||
### Local Development
|
||||
|
||||
```bash
|
||||
# Clone the repo
|
||||
git clone https://git.psmattas.com/Evercatch/REPO_NAME.git
|
||||
cd REPO_NAME
|
||||
|
||||
# Copy environment variables
|
||||
cp .env.example .env
|
||||
|
||||
# Start services
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌿 Branching & Commits
|
||||
|
||||
All work follows the Evercatch contribution guide defined in the org README.
|
||||
|
||||
**Branch format:** `EC-ID-short-description`
|
||||
**Commit format:** `EC-00: type(scope): message`
|
||||
|
||||
See [Evercatch Org README](https://git.psmattas.com/Evercatch) for full conventions.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ CI/CD
|
||||
|
||||
Automated via Jenkins. Merges to `main` trigger staging deployments.
|
||||
|
||||
| Pipeline | Status |
|
||||
| :--- | :---: |
|
||||
| Build |  |
|
||||
| Lint |  |
|
||||
| Test |  |
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
|
||||
**Copyright © 2026 Evercatch.**
|
||||
Proprietary and confidential. Unauthorised distribution is strictly prohibited.
|
||||
Reference in New Issue
Block a user