Skip to content

CISCODE-MA/comptaleyes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

73 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Comptaleyes Platform

Modern accounting and finance management platform built with scalable microservices architecture.

πŸ“‹ Project Overview

Comptaleyes is a full-stack web application designed for accounting and financial management. The platform features a NestJS backend API, React frontend, and automated AWS infrastructure deployment using CDK.

πŸ—οΈ Architecture

This monorepo contains three main components:

comptaleyes/
β”œβ”€β”€ backend/          # NestJS API with authentication & business logic
β”œβ”€β”€ frontend/         # React SPA with modern UI components
β”œβ”€β”€ infra/            # AWS CDK infrastructure as code
└── .github/          # CI/CD workflows (GitHub Actions)

Backend

  • Framework: NestJS (Node.js 22)
  • Database: MongoDB Atlas
  • Authentication: JWT + OAuth2 (Microsoft, Google, Facebook)
  • Email: SMTP-based verification & password reset
  • Deployment: Docker β†’ AWS ECR β†’ EC2

Frontend

  • Framework: React 19 with TypeScript
  • Build Tool: Vite
  • UI Library: @ciscode/ui-authentication-kit
  • Deployment: S3 + CloudFront CDN

Infrastructure

  • IaC: AWS CDK (TypeScript)
  • Compute: EC2 for backend containers
  • Storage: S3 for frontend static assets
  • CDN: CloudFront for global distribution
  • Secrets: SSM Parameter Store

πŸš€ Quick Start

Prerequisites

  • Node.js 22+ and npm
  • Docker Desktop
  • AWS CLI configured (for deployment)
  • MongoDB Atlas account

Backend Setup

cd backend
cp .env.example .env
# Edit .env with your credentials
npm install
npm run dev

Backend will be available at http://localhost:3000

Health Check: curl http://localhost:3000/health

Frontend Setup

cd frontend
cp .env.example .env
# Edit .env with backend URL
npm install
npm run dev

Frontend will be available at http://localhost:5173

Full Stack with Docker

cd backend
docker compose -f compose/docker-compose.dev.yml up --build

πŸ“š Documentation

πŸ” Environment Configuration

All sensitive credentials are stored in .env files (local) or AWS SSM Parameter Store (production).

Required Environment Variables: See .env.example files in each directory:

πŸ§ͺ Testing

# Backend tests
cd backend
npm test                 # All tests
npm run test:watch       # Watch mode
npm run test:cov         # Coverage report

# Frontend tests
cd frontend
npm test

🚒 Deployment

CI/CD Pipelines

GitHub Actions workflows handle automated deployments:

  • Backend CI: PR validation (lint, test, typecheck)
  • Backend CD: Build Docker β†’ ECR β†’ EC2 deployment
  • Frontend CI: PR validation (lint, test, typecheck)
  • Frontend CD: Build Vite β†’ S3 β†’ CloudFront invalidation
  • CDK Deploy: Infrastructure updates via CDK

Manual Deployment

# Deploy infrastructure
cd infra
npm run build
npx cdk deploy --all

# Deploy backend (via GitHub Actions)
git push origin master  # Triggers backend-cd.yml

# Deploy frontend (via GitHub Actions)
git push origin master  # Triggers frontend-cd.yml

πŸƒ Production Environments

  • Frontend: Deployed via CloudFront CDN for global distribution
  • Backend API: Deployed on AWS EC2 with Docker
  • Database: MongoDB Atlas
  • Infrastructure: AWS (us-east-1 region)

πŸ› οΈ Development Workflow

  1. Create feature branch from develop
  2. Make changes and commit
  3. Push and create PR β†’ develop
  4. CI pipeline validates (lint, test, typecheck)
  5. After review, merge to develop
  6. When ready for release, PR β†’ master triggers deployment

πŸ“¦ Tech Stack Summary

Component Technologies
Backend NestJS, TypeScript, MongoDB, Docker
Frontend React, Vite, TailwindCSS, React Router
Authentication JWT, OAuth2, @ciscode/authentication-kit
Infrastructure AWS CDK, EC2, S3, CloudFront, ECR
CI/CD GitHub Actions with OIDC
Monitoring CloudWatch Logs, Health endpoints

🀝 Contributing

See CONTRIBUTING.md for development guidelines.

πŸ”’ Security

To report security vulnerabilities: info@ciscod.com

See SECURITY for our security policy.

πŸ“ License

MIT License - See LICENSE file for details.

Copyright (c) 2026 CisCode