Feature/implement observability and resilience

.env.example

@@ -0,0 +1,15 @@
+DATABASE_URL=postgresql://username:password@localhost:5432/vesting_vault
+DB_HOST=localhost
+DB_PORT=5432
+DB_NAME=vesting_vault
+DB_USER=username
+DB_PASSWORD=password
+
+STELLAR_RPC_URL=https://horizon-testnet.stellar.org
+STELLAR_NETWORK=testnet
+SOROBAN_RPC_URL=https://soroban-rpc.testnet.stellar.org
+VAULT_CONTRACT_ADDRESS=CD5QF6KBAURVUNZR2EVBJISWSEYGDGEEYVH2XYJJADKT7KFOXTTIXLHU
+
+APPROVED_VAULT_WASM_HASH=7792a624b562b3d9414792f5fb5d72f53b9838fef2ed9a901471253970bc3b15
+
+PORT=3000

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Vesting API Tests
+name: Vesting Vault Tests
 
 on:
   push:
@@ -9,11 +9,27 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: backend
+
+    env:
+      NODE_ENV: test
+
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: npm ci
-      - run: npm test
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: backend/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+

.gitignore

@@ -0,0 +1,61 @@
+# Dependencies
+node_modules/
+backend/node_modules/
+
+# Environment variables
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# 
+node_modules
+Coverage directory used by tools like istanbul
+coverage/
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Dependency directories
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env.test
+node_modules

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "kiroAgent.configureMCP": "Disabled"
+}

ARCHITECTURE.md

@@ -0,0 +1,18 @@
+# Backend Architecture
+
+## Data Flow Overview
+
+```mermaid
+flowchart TD
+    A[Stellar Horizon API] --> B[RPC Indexer]
+    B --> C[PostgreSQL Database]
+    C --> D[Express API]
+    D --> E[Dashboard UI]
+```
+
+## Explanation
+
+1. The RPC Indexer fetches vesting-related data from the Stellar Horizon API.
+2. The RPC Indexer processes and stores the data in the PostgreSQL database.
+3. The Express API reads data from the PostgreSQL database.
+4. The Dashboard UI consumes data from the Express API.

CONTRIBUTING.md

@@ -0,0 +1,206 @@
+# Contributing to Vesting Vault
+
+Thank you for your interest in contributing to Vesting Vault! This guide will help you get the development environment set up and running quickly.
+
+## Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+- [Docker](https://docs.docker.com/get-docker/) (v20.10 or later)
+- [Docker Compose](https://docs.docker.com/compose/install/) (v2.0 or later)
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+## Quick Start (Recommended)
+
+The fastest way to get started is using Docker Compose:
+
+1. **Clone the repository**
+   ```bash
+   git clone <repository-url>
+   cd Vesting-Vault
+   ```
+
+2. **Start all services**
+   ```bash
+   docker-compose up -d
+   ```
+
+3. **Verify services are running**
+   ```bash
+   # Check backend health
+   curl http://localhost:3000/health
+
+   # Check all services status
+   docker-compose ps
+   ```
+
+That's it! Your development environment is now running with:
+- Backend API: http://localhost:3000
+- PostgreSQL Database: localhost:5432
+- Redis Cache: localhost:6379
+
+## Development Workflow
+
+### Running Services
+
+```bash
+# Start all services in detached mode
+docker-compose up -d
+
+# Start services with logs
+docker-compose up
+
+# Stop all services
+docker-compose down
+
+# Stop services and remove volumes (clean slate)
+docker-compose down -v
+```
+
+### Viewing Logs
+
+```bash
+# View all logs
+docker-compose logs
+
+# View specific service logs
+docker-compose logs backend
+docker-compose logs db
+docker-compose logs redis
+
+# Follow logs in real-time
+docker-compose logs -f backend
+```
+
+### Backend Development
+
+The backend service is configured for development with hot-reloading:
+
+```bash
+# Access the backend container
+docker-compose exec backend sh
+
+# Install new dependencies
+docker-compose exec backend npm install <package-name>
+
+# Run tests
+docker-compose exec backend npm test
+
+# Access database directly
+docker-compose exec db psql -U postgres -d vesting_vault
+```
+
+### Database Management
+
+```bash
+# Connect to PostgreSQL
+docker-compose exec db psql -U postgres -d vesting_vault
+
+# Create database migrations (if using Sequelize)
+docker-compose exec backend npx sequelize-cli migration:create --name migration_name
+
+# Run migrations
+docker-compose exec backend npx sequelize-cli db:migrate
+```
+
+## Environment Configuration
+
+### Backend Environment Variables
+
+Copy the example environment file and customize as needed:
+
+```bash
+cp backend/.env.example backend/.env
+```
+
+Key environment variables:
+- `PORT`: Backend server port (default: 3000)
+- `NODE_ENV`: Environment (development/production)
+- `DB_HOST`: Database host (default: db for Docker)
+- `DB_PORT`: Database port (default: 5432)
+- `DB_NAME`: Database name (default: vesting_vault)
+- `DB_USER`: Database user (default: postgres)
+- `DB_PASSWORD`: Database password (default: password)
+- `STELLAR_RPC_URL`: Stellar RPC endpoint (e.g., https://soroban-testnet.stellar.org)
+- `STELLAR_NETWORK_PASSPHRASE`: Passphrase for the configured network
+
+## Project Structure
+
+```
+Vesting-Vault/
+├── backend/                 # Node.js backend application
+│   ├── src/
+│   │   ├── index.js        # Application entry point
+│   │   └── database/        # Database configuration
+│   ├── Dockerfile          # Backend Docker configuration
+│   ├── package.json        # Node.js dependencies
+│   └── .env.example        # Environment variables template
+├── docker-compose.yml      # Docker services configuration
+└── CONTRIBUTING.md         # This file
+```
+
+## Common Issues & Solutions
+
+### Port Conflicts
+
+If you encounter port conflicts, modify the port mappings in `docker-compose.yml`:
+
+```yaml
+ports:
+  - "3001:3000"  # Change host port from 3000 to 3001
+```
+
+### Database Connection Issues
+
+1. Ensure the database service is healthy:
+   ```bash
+   docker-compose ps
+   ```
+
+2. Check database logs:
+   ```bash
+   docker-compose logs db
+   ```
+
+3. Verify environment variables in your `.env` file match the database configuration.
+
+### Permission Issues (Linux/Mac)
+
+If you encounter permission errors, run:
+
+```bash
+sudo chown -R $USER:$USER .
+```
+
+## Development Tips
+
+1. **Use meaningful commit messages** following conventional commit format
+2. **Run tests before committing** changes
+3. **Check logs** when services don't start properly
+4. **Use `docker-compose down -v`** for a completely fresh start
+5. **Monitor resource usage** with `docker stats`
+
+## API Endpoints
+
+Once the backend is running, you can access:
+
+- `GET /` - Welcome message
+- `GET /health` - Health check endpoint
+
+## Getting Help
+
+If you encounter issues:
+
+1. Check the troubleshooting section above
+2. Review service logs: `docker-compose logs`
+3. Ensure Docker and Docker Compose are up to date
+4. Check that ports 3000, 5432, and 6379 are available
+
+## Code Style Guidelines
+
+- Use ESLint for JavaScript code formatting
+- Follow conventional commit message format
+- Write meaningful variable and function names
+- Add comments for complex logic
+
+Thank you for contributing to Vesting Vault! 🚀