275 lines
6.7 KiB
Markdown
275 lines
6.7 KiB
Markdown
# The Order
|
|
|
|
**A Phoenix-native platform for digital identity, verifiable credentials, and legal document management**
|
|
|
|
[](LICENSE)
|
|
[](https://www.typescriptlang.org/)
|
|
[](https://nodejs.org/)
|
|
|
|
## Overview
|
|
|
|
The Order is a sovereign platform providing:
|
|
- **Digital Identity Management**: eIDAS/DID-based identity verification
|
|
- **Verifiable Credentials**: DID and issuer-domain based credential services
|
|
- **Legal Document Management**: Comprehensive DMS for law firms and courts
|
|
- **Virtual Data Rooms**: Secure deal management
|
|
- **Financial Services**: Payment processing and invoicing
|
|
- **e-Residency**: Digital residency services
|
|
|
|
Built for **Sankofa Phoenix / Proxmox** operations, with data residency, compliance, and operational control anchored in the Sankofa runtime.
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js >= 18.0.0
|
|
- pnpm >= 8.0.0
|
|
- Docker & Docker Compose
|
|
- Proxmox / Sankofa Phoenix operator access for deployment tasks
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone <repository-url>
|
|
cd the-order
|
|
|
|
# Install dependencies
|
|
pnpm install
|
|
|
|
# Start local services (PostgreSQL, Redis, OpenSearch)
|
|
docker-compose up -d
|
|
|
|
# Build all packages
|
|
pnpm build
|
|
|
|
# Start development servers
|
|
pnpm dev
|
|
```
|
|
|
|
### Environment Setup
|
|
|
|
1. Copy `.env.example` to `.env`
|
|
2. Configure the local environment variables needed for your workload.
|
|
3. Load environment:
|
|
```bash
|
|
source .env
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
the-order/
|
|
├── apps/ # Frontend applications
|
|
├── services/ # Backend microservices
|
|
├── packages/ # Shared libraries
|
|
├── infra/ # Infrastructure as Code
|
|
├── docs/ # Documentation
|
|
└── scripts/ # Utility scripts
|
|
```
|
|
|
|
**📖 See [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) for detailed structure guide**
|
|
|
|
## Architecture
|
|
|
|
### Services
|
|
|
|
- **Identity Service** (`services/identity/`): eIDAS/DID, verifiable credentials, identity management
|
|
- **Intake Service** (`services/intake/`): Document ingestion, OCR, classification
|
|
- **Finance Service** (`services/finance/`): Payments, ledgers, invoicing
|
|
- **Dataroom Service** (`services/dataroom/`): Virtual data rooms, deal management
|
|
- **Legal Documents Service** (`services/legal-documents/`): Comprehensive document management
|
|
- **e-Residency Service** (`services/eresidency/`): Digital residency services
|
|
|
|
### Applications
|
|
|
|
- **MCP Legal** (`apps/mcp-legal/`): Legal document management portal
|
|
- **Portal Public** (`apps/portal-public/`): Public-facing member portal
|
|
- **Portal Internal** (`apps/portal-internal/`): Internal administrative portal
|
|
|
|
### Infrastructure
|
|
|
|
- **Kubernetes** (`infra/k8s/`): Container orchestration manifests for containerized workloads
|
|
- **Monitoring** (`infra/monitoring/`): Prometheus, Grafana
|
|
|
|
## Documentation
|
|
|
|
### Getting Started
|
|
- [Project Structure](PROJECT_STRUCTURE.md) - Complete structure guide
|
|
- [Quick Start Guide](QUICKSTART.md) - Development setup
|
|
- [Architecture Overview](docs/architecture/README.md) - System architecture
|
|
|
|
### Deployment
|
|
- [Deployment Overview](docs/deployment/overview.md) - Sankofa Phoenix deployment model
|
|
- [Deployment Quick Reference](docs/deployment/DEPLOYMENT_QUICK_REFERENCE.md) - operator commands
|
|
- [Kubernetes Deployment](infra/k8s/README.md) - K8s deployment guide
|
|
|
|
### Architecture
|
|
- [Cloud for Sovereignty Landing Zone](docs/architecture/CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md) - Complete architecture
|
|
- [Well-Architected Framework](docs/architecture/README.md) - Architecture principles
|
|
- [Data Models](docs/architecture/README.md#data-models) - Entity relationships
|
|
|
|
### Integrations
|
|
- [Legacy Provider Archive](archive/quarantined-legacy-stack/README.md) - quarantined historical material
|
|
|
|
### Legal System
|
|
- [Document Management](docs/legal/document-management/) - DMS documentation
|
|
- [API Documentation](docs/legal/document-management/implementation/) - API reference
|
|
|
|
## Development
|
|
|
|
### Commands
|
|
|
|
```bash
|
|
# Install dependencies
|
|
pnpm install
|
|
|
|
# Build all packages
|
|
pnpm build
|
|
|
|
# Run tests
|
|
pnpm test
|
|
|
|
# Start development
|
|
pnpm dev
|
|
|
|
# Lint code
|
|
pnpm lint
|
|
|
|
# Type check
|
|
pnpm type-check
|
|
```
|
|
|
|
### Working with Services
|
|
|
|
```bash
|
|
# Start specific service
|
|
pnpm --filter @the-order/identity-service dev
|
|
|
|
# Build specific service
|
|
pnpm --filter @the-order/identity-service build
|
|
|
|
# Test specific service
|
|
pnpm --filter @the-order/identity-service test
|
|
```
|
|
|
|
### Working with Packages
|
|
|
|
```bash
|
|
# Build specific package
|
|
pnpm --filter @the-order/database build
|
|
|
|
# Test specific package
|
|
pnpm --filter @the-order/database test
|
|
```
|
|
|
|
## Infrastructure
|
|
|
|
### Sankofa Phoenix Deployment
|
|
|
|
```bash
|
|
# Preview the full Phoenix-native flow
|
|
./scripts/deploy/deploy.sh --all --environment dev --dry-run
|
|
```
|
|
|
|
### Kubernetes Deployment
|
|
|
|
```bash
|
|
# Apply base configuration
|
|
kubectl apply -k infra/k8s/base
|
|
|
|
# Apply environment overlay
|
|
kubectl apply -k infra/k8s/overlays/dev
|
|
```
|
|
|
|
## Key Features
|
|
|
|
### Digital Identity
|
|
- ✅ eIDAS compliance
|
|
- ✅ DID (Decentralized Identifiers)
|
|
- ✅ DID and issuer-domain based credential issuance
|
|
- ✅ Verifiable Credentials
|
|
|
|
### Document Management
|
|
- ✅ Document templates
|
|
- ✅ Version control
|
|
- ✅ Legal matter management
|
|
- ✅ Court filing integration
|
|
- ✅ Real-time collaboration
|
|
- ✅ E-signatures
|
|
|
|
### Security & Compliance
|
|
- ✅ Sankofa Phoenix operational control
|
|
- ✅ Data residency enforcement
|
|
- ✅ Customer-managed encryption
|
|
- ✅ Private endpoints
|
|
- ✅ GDPR & eIDAS compliance
|
|
|
|
### Infrastructure
|
|
- ✅ Phoenix / Proxmox deployment flow
|
|
- ✅ Well-Architected Framework
|
|
- ✅ Infrastructure as Code
|
|
- ✅ Automated deployments
|
|
- ✅ Comprehensive monitoring
|
|
|
|
## Technology Stack
|
|
|
|
### Frontend
|
|
- React 18+
|
|
- Next.js 14+
|
|
- TypeScript
|
|
- Tailwind CSS
|
|
- Material-UI
|
|
|
|
### Backend
|
|
- Node.js 18+
|
|
- TypeScript
|
|
- Fastify
|
|
- PostgreSQL
|
|
- Redis
|
|
|
|
### Infrastructure
|
|
- Sankofa Phoenix / Proxmox
|
|
- Kubernetes
|
|
- Docker
|
|
|
|
### Monitoring
|
|
- Prometheus
|
|
- Grafana
|
|
- OpenTelemetry
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](docs/governance/CONTRIBUTING.md) for contribution guidelines.
|
|
|
|
## Security
|
|
|
|
See [SECURITY.md](docs/governance/SECURITY.md) for security policies and reporting.
|
|
|
|
## License
|
|
|
|
See [LICENSE](LICENSE) for license information.
|
|
|
|
## Support
|
|
|
|
- **Documentation**: See `docs/` directory
|
|
- **Architecture**: See `docs/architecture/`
|
|
- **Deployment**: See `docs/deployment/`
|
|
- **Issues**: Use GitHub Issues
|
|
|
|
## Status
|
|
|
|
**Current Status**: Active Development
|
|
|
|
- ✅ Core services implemented
|
|
- ✅ Legal document management complete
|
|
- ✅ Phoenix-native identity flow complete
|
|
- ✅ Multi-region infrastructure planned
|
|
- 🔄 Testing and optimization in progress
|
|
|
|
See [docs/reports/](docs/reports/) for detailed status reports.
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-01-27
|