Update README.md to provide a comprehensive overview of The Order monorepo, including repository structure, quickstart guide, development workflow, and contribution guidelines.
This commit is contained in:
44
services/dataroom/README.md
Normal file
44
services/dataroom/README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Dataroom Service
|
||||
|
||||
Service for secure VDR (Virtual Data Room), deal rooms, and document access control.
|
||||
|
||||
## Features
|
||||
|
||||
- Deal space management
|
||||
- Folder ACLs (OPA policies)
|
||||
- Watermarking
|
||||
- Expiring links
|
||||
- Activity logs
|
||||
- Integration with finance service for deal states
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Run development server
|
||||
pnpm dev
|
||||
|
||||
# Build
|
||||
pnpm build
|
||||
|
||||
# Start production server
|
||||
pnpm start
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
|
||||
- `GET /health` - Health check
|
||||
- `POST /deals` - Create deal room
|
||||
- `GET /deals/:dealId` - Get deal room
|
||||
- `POST /deals/:dealId/documents` - Upload document
|
||||
- `GET /deals/:dealId/documents/:documentId/url` - Get presigned URL
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `PORT` - Server port (default: 4004)
|
||||
- `DATABASE_URL` - PostgreSQL connection string
|
||||
- `STORAGE_BUCKET` - Storage bucket for documents
|
||||
- `OPA_URL` - Open Policy Agent URL for access control
|
||||
|
||||
Reference in New Issue
Block a user