6a8582e54d
- Add Cloud for Sovereignty landing zone architecture and deployment - Implement complete legal document management system - Reorganize documentation with improved navigation - Add infrastructure improvements (Dockerfiles, K8s, monitoring) - Add operational improvements (graceful shutdown, rate limiting, caching) - Create comprehensive project structure documentation - Add Azure deployment automation scripts - Improve repository navigation and organization
2.5 KiB
2.5 KiB
Getting Started with The Order
Welcome to The Order! This guide will help you get started with development, deployment, and operations.
Prerequisites
- Node.js: 20.x or later
- pnpm: 8.x or later
- Docker: For containerized services
- Azure CLI: For Azure deployments
- Terraform: For infrastructure as code
- kubectl: For Kubernetes operations
Quick Start
1. Clone and Install
git clone <repository-url>
cd the_order
pnpm install
2. Configure Environment
cp .env.example .env
# Edit .env with your configuration
See Configuration Guide for details.
3. Start Development
# Start all services
pnpm dev
# Or start specific service
pnpm --filter @the-order/identity dev
4. Access Services
- Identity Service: http://localhost:4001
- Intake Service: http://localhost:4002
- Finance Service: http://localhost:4003
- Dataroom Service: http://localhost:4004
- Legal Documents Service: http://localhost:4005
- MCP Legal Portal: http://localhost:3000
Next Steps
For Developers
- Read Architecture Documentation
- Review API Documentation
- Check Contributing Guidelines
For Operators
- Review Operations Runbooks
- Study Deployment Guide
- Complete Training Materials
For Product/Management
- Review Product Documentation
- Understand Governance Framework
- Review Legal Policies
Common Tasks
Running Tests
pnpm test
Building for Production
pnpm build
Deploying to Azure
./scripts/deploy/deploy.sh --all --environment dev
Database Migrations
pnpm --filter @the-order/database migrate
Getting Help
- Documentation: Browse this directory
- Issues: Check GitHub issues
- Contributing: See Contributing Guidelines
Architecture Overview
The Order is a monorepo with:
- Services: Backend microservices (Identity, Intake, Finance, etc.)
- Packages: Shared libraries and utilities
- Apps: Frontend applications (Portals)
- Infrastructure: Terraform, Kubernetes, CI/CD
See Architecture Documentation for details.
Last Updated: 2025-01-27