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:
86
apps/README.md
Normal file
86
apps/README.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Applications Directory
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Purpose**: Frontend applications overview
|
||||
|
||||
## Overview
|
||||
|
||||
This directory contains frontend applications built with React, Next.js, and TypeScript.
|
||||
|
||||
## Available Applications
|
||||
|
||||
### MCP Legal (`mcp-legal/`)
|
||||
- **Purpose**: Legal document management portal
|
||||
- **Technology**: React, Material-UI, React Query
|
||||
- **Features**: Document management, matter management, template library
|
||||
- **Documentation**: [MCP Legal README](mcp-legal/README.md)
|
||||
|
||||
### Portal Public (`portal-public/`)
|
||||
- **Purpose**: Public-facing member portal
|
||||
- **Technology**: Next.js, React, Tailwind CSS
|
||||
- **Features**: Member services, credential management
|
||||
- **Documentation**: [Portal Public README](portal-public/README.md)
|
||||
|
||||
### Portal Internal (`portal-internal/`)
|
||||
- **Purpose**: Internal administrative portal
|
||||
- **Technology**: Next.js, React, Tailwind CSS
|
||||
- **Features**: Administration, reporting, analytics
|
||||
- **Documentation**: [Portal Internal README](portal-internal/README.md)
|
||||
|
||||
## Application Structure
|
||||
|
||||
All applications follow a consistent structure:
|
||||
|
||||
```
|
||||
app/
|
||||
├── src/
|
||||
│ ├── app/ # Next.js app directory (if using App Router)
|
||||
│ ├── components/ # React components
|
||||
│ ├── pages/ # Next.js pages (if using Pages Router)
|
||||
│ ├── hooks/ # React hooks
|
||||
│ ├── utils/ # Utility functions
|
||||
│ └── types/ # TypeScript types
|
||||
├── public/ # Static assets
|
||||
├── package.json # Dependencies
|
||||
└── README.md # Application documentation
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Running Applications
|
||||
|
||||
```bash
|
||||
# Start all applications
|
||||
pnpm dev
|
||||
|
||||
# Start specific application
|
||||
pnpm --filter portal-public dev
|
||||
```
|
||||
|
||||
### Building Applications
|
||||
|
||||
```bash
|
||||
# Build all applications
|
||||
pnpm build
|
||||
|
||||
# Build specific application
|
||||
pnpm --filter portal-public build
|
||||
```
|
||||
|
||||
## Shared Components
|
||||
|
||||
Applications use shared UI components from `packages/ui/`:
|
||||
```typescript
|
||||
import { Button, Card, Modal } from '@the-order/ui';
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Project Structure](../PROJECT_STRUCTURE.md)
|
||||
- [Packages Documentation](../packages/)
|
||||
- [Architecture Documentation](../docs/architecture/)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
|
||||
Reference in New Issue
Block a user