Files
Aseret_Global/README.md
2026-02-09 21:51:31 -08:00

3.9 KiB

Aseret Global - Monorepo

Status: 🚧 Placeholder - Under Planning
Purpose: Unified monorepository for Aseret Global ecosystem projects.


Overview

Aseret Global is a monorepository that consolidates multiple banking, financial, and global services projects under a unified structure with shared code, tooling, and dependency management.


Monorepo Structure

This monorepo uses git submodules to manage related projects:

Aseret_Global/
├── .gitmodules                # Git submodules configuration
├── TC_Worldwide/              # TC Worldwide project (submodule)
├── Aseret_Bank/               # Aseret Bank project (submodule)
├── Solace_Bank_Group/         # Solace Bank Group project (submodule)
├── Tamales/                   # Tamales project (submodule)
├── TAJ_PSFO/                  # TAJ PSFO project (submodule)
├── packages/                  # Shared packages (planned)
│   └── shared/                # Shared libraries and utilities
├── tools/                     # Development tools (planned)
└── docs/                      # Documentation (planned)

Submodules

TC_Worldwide

Status: Active
Description: TC Worldwide project - details to be documented

Aseret_Bank

Status: Active
Description: Aseret Bank project - banking and financial services

Solace_Bank_Group

Status: Active
Description: Solace Bank Group project - banking group services

Tamales

Status: Active
Description: Tamales project - details to be documented

TAJ_PSFO

Status: Active
Description: TAJ PSFO project - details to be documented


Getting Started

Clone with Submodules

# Clone repository with all submodules
git clone --recurse-submodules <repository-url>
cd Aseret_Global

# Or if already cloned, initialize submodules
git submodule update --init --recursive

Update Submodules

# Update all submodules to latest commits
git submodule update --remote

# Update specific submodule
cd TC_Worldwide
git pull origin main
cd ..
git add TC_Worldwide
git commit -m "Update TC_Worldwide submodule"

Working with Submodules

# Work on a submodule
cd TC_Worldwide
# Make changes and commit
git add .
git commit -m "Your changes"
git push
cd ..

# Update parent repo to reference new submodule commit
git add TC_Worldwide
git commit -m "Update TC_Worldwide submodule reference"
git push

Shared Resources (Planned)

Shared Packages

  • Common utilities and types
  • API clients
  • Authentication libraries
  • Configuration management

Shared Tooling

  • Build scripts
  • Testing frameworks
  • CI/CD pipelines
  • Documentation generators

Development Workflow (Planned)

Monorepo Tooling

  • Package Manager: pnpm workspaces (recommended) or npm/yarn
  • Build Tool: Turborepo or Nx (for build orchestration)
  • Versioning: Unified or independent versioning (TBD)

Development Commands

# Install dependencies for all projects
pnpm install

# Build all projects
pnpm build

# Test all projects
pnpm test

# Lint all projects
pnpm lint

Project Relationships

Integration Points

Projects in this monorepo may integrate with:

  • Shared authentication and authorization
  • Common API clients
  • Unified configuration management
  • Coordinated deployment pipelines

Documentation

Project-specific documentation is maintained in each submodule's repository. Monorepo-level documentation will be added as the structure is developed.


Contributing

When contributing:

  1. Follow monorepo standards
  2. Update affected submodules
  3. Test across projects
  4. Update documentation

License

[To be determined]


Status

Current Status: 🚧 Placeholder
Next Steps:

  • Define monorepo structure
  • Set up shared packages
  • Configure build tooling
  • Begin integration

Last Updated: 2025-01-27