feat: comprehensive project structure improvements and Cloud for Sovereignty landing zone
- 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
This commit is contained in:
111
docs/GETTING_STARTED.md
Normal file
111
docs/GETTING_STARTED.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# 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
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd the_order
|
||||
pnpm install
|
||||
```
|
||||
|
||||
### 2. Configure Environment
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
# Edit .env with your configuration
|
||||
```
|
||||
|
||||
See [Configuration Guide](configuration/ENVIRONMENT_VARIABLES.md) for details.
|
||||
|
||||
### 3. Start Development
|
||||
|
||||
```bash
|
||||
# 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
|
||||
1. Read [Architecture Documentation](architecture/README.md)
|
||||
2. Review [API Documentation](api/README.md)
|
||||
3. Check [Contributing Guidelines](governance/policies/contributing.md)
|
||||
|
||||
### For Operators
|
||||
1. Review [Operations Runbooks](operations/README.md)
|
||||
2. Study [Deployment Guide](deployment/README.md)
|
||||
3. Complete [Training Materials](training/README.md)
|
||||
|
||||
### For Product/Management
|
||||
1. Review [Product Documentation](product/README.md)
|
||||
2. Understand [Governance Framework](governance/README.md)
|
||||
3. Review [Legal Policies](legal/README.md)
|
||||
|
||||
## Common Tasks
|
||||
|
||||
### Running Tests
|
||||
```bash
|
||||
pnpm test
|
||||
```
|
||||
|
||||
### Building for Production
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
### Deploying to Azure
|
||||
```bash
|
||||
./scripts/deploy/deploy.sh --all --environment dev
|
||||
```
|
||||
|
||||
### Database Migrations
|
||||
```bash
|
||||
pnpm --filter @the-order/database migrate
|
||||
```
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Documentation**: Browse this directory
|
||||
- **Issues**: Check GitHub issues
|
||||
- **Contributing**: See [Contributing Guidelines](governance/policies/contributing.md)
|
||||
|
||||
## 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](architecture/README.md) for details.
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
Reference in New Issue
Block a user