108 lines
1.8 KiB
Markdown
108 lines
1.8 KiB
Markdown
|
# DBIS Monorepo
|
||
|
|
|
||
|
|
**Purpose**: Unified monorepo for all DBIS-related projects
|
||
|
|
**Status**: 🚧 Setup Complete - Ready for Migration
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This monorepo consolidates all DBIS-related projects into a single repository for improved code sharing, unified CI/CD, and streamlined development.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Structure
|
||
|
|
|
||
|
|
```
|
||
|
|
dbis_monorepo/
|
||
|
|
├── packages/ # Shared packages
|
||
|
|
│ ├── shared-types # TypeScript types
|
||
|
|
│ ├── shared-utils # Utility functions
|
||
|
|
│ ├── shared-auth # Authentication utilities
|
||
|
|
│ └── api-client # API client
|
||
|
|
├── apps/ # Applications
|
||
|
|
│ └── (to be migrated)
|
||
|
|
├── tools/ # Development tools
|
||
|
|
│ └── (to be migrated)
|
||
|
|
├── infrastructure/ # Infrastructure as code
|
||
|
|
└── docs/ # Documentation
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
- Node.js >= 18.0.0
|
||
|
|
- pnpm >= 8.0.0
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm install
|
||
|
|
```
|
||
|
|
|
||
|
|
### Build
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm build
|
||
|
|
```
|
||
|
|
|
||
|
|
### Test
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm test
|
||
|
|
```
|
||
|
|
|
||
|
|
### Development
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm dev
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Shared Packages
|
||
|
|
|
||
|
|
### @dbis/shared-types
|
||
|
|
TypeScript types shared across DBIS projects.
|
||
|
|
|
||
|
|
### @dbis/shared-utils
|
||
|
|
Utility functions shared across DBIS projects.
|
||
|
|
|
||
|
|
### @dbis/shared-auth
|
||
|
|
Authentication utilities shared across DBIS projects.
|
||
|
|
|
||
|
|
### @dbis/api-client
|
||
|
|
API client for DBIS services.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## CI/CD
|
||
|
|
|
||
|
|
Unified CI/CD is configured in `.github/workflows/ci.yml`:
|
||
|
|
- Build all packages
|
||
|
|
- Run tests
|
||
|
|
- Lint code
|
||
|
|
- Type check
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Migration
|
||
|
|
|
||
|
|
See `docs/DBIS_MIGRATION_CHECKLIST.md` for migration instructions.
|
||
|
|
|
||
|
|
Use `scripts/migrate-dbis-project.sh` to help migrate projects.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
- [Migration Plan](../docs/DBIS_MONOREPO_MIGRATION_PLAN.md)
|
||
|
|
- [Migration Checklist](../docs/DBIS_MIGRATION_CHECKLIST.md)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Status**: 🚧 Setup Complete - Ready for Project Migration
|