Initial commit: add .gitignore and README
This commit is contained in:
defiQUG
49
.gitignore
vendored
Normal file
49
.gitignore
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
# Dependencies
|
||||
node_modules/
|
||||
.pnpm-store/
|
||||
vendor/
|
||||
|
||||
# Package manager lock files (optional: uncomment to ignore)
|
||||
# package-lock.json
|
||||
# yarn.lock
|
||||
|
||||
# Environment and secrets
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
*.env.backup
|
||||
.env.backup.*
|
||||
|
||||
# Logs and temp
|
||||
*.log
|
||||
logs/
|
||||
*.tmp
|
||||
*.temp
|
||||
*.tmp.*
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Build / output
|
||||
dist/
|
||||
build/
|
||||
.next/
|
||||
out/
|
||||
*.pyc
|
||||
__pycache__/
|
||||
.eggs/
|
||||
*.egg-info/
|
||||
.coverage
|
||||
htmlcov/
|
||||
|
||||
# Optional
|
||||
.reports/
|
||||
reports/
|
||||
182
README.md
Normal file
182
README.md
Normal file
@@ -0,0 +1,182 @@
|
||||
# Elemental Imperium - Monorepo
|
||||
|
||||
**Status**: ✅ **Active**
|
||||
**Purpose**: Unified monorepository for Elemental Imperium projects. This is 1/3 of the DBIS Tripartite Body.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Elemental Imperium is a monorepository that consolidates projects related to the DBIS (Digital Bank of International Settlements) ecosystem. As part of the DBIS Tripartite Body, this monorepo manages critical infrastructure and services.
|
||||
|
||||
---
|
||||
|
||||
## DBIS Tripartite Body
|
||||
|
||||
Elemental Imperium represents **1/3 of the DBIS Tripartite Body**, a three-part governance and operational structure for the Digital Bank of International Settlements.
|
||||
|
||||
---
|
||||
|
||||
## Monorepo Structure
|
||||
|
||||
This monorepo uses git submodules to manage related projects:
|
||||
|
||||
```
|
||||
Elemental_Imperium/
|
||||
├── .gitmodules # Git submodules configuration
|
||||
├── OMNL/ # OMNL project (submodule)
|
||||
├── packages/ # Shared packages (planned)
|
||||
│ └── shared/ # Shared libraries and utilities
|
||||
├── tools/ # Development tools (planned)
|
||||
└── docs/ # Documentation (planned)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Submodules
|
||||
|
||||
### OMNL
|
||||
**Status**: Active
|
||||
**Description**: OMNL (Omniversal Meta Network Layer) - Details to be documented
|
||||
|
||||
**Relationship**: Core component of Elemental Imperium infrastructure
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Clone with Submodules
|
||||
|
||||
```bash
|
||||
# Clone repository with all submodules
|
||||
git clone --recurse-submodules <repository-url>
|
||||
cd Elemental_Imperium
|
||||
|
||||
# Or if already cloned, initialize submodules
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
### Update Submodules
|
||||
|
||||
```bash
|
||||
# Update all submodules to latest commits
|
||||
git submodule update --remote
|
||||
|
||||
# Update OMNL submodule
|
||||
cd OMNL
|
||||
git pull origin main
|
||||
cd ..
|
||||
git add OMNL
|
||||
git commit -m "Update OMNL submodule"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Integration with DBIS Ecosystem
|
||||
|
||||
### DBIS Tripartite Body
|
||||
Elemental Imperium is part of the three-part DBIS structure:
|
||||
- **Elemental Imperium** (this monorepo) - 1/3
|
||||
- **Other Tripartite Members** - TBD
|
||||
|
||||
### DBIS Integration Points
|
||||
- Integration with **dbis_core** banking system
|
||||
- Integration with **smom-dbis-138** blockchain infrastructure
|
||||
- Governance and operational coordination
|
||||
- Shared infrastructure and services
|
||||
|
||||
---
|
||||
|
||||
## Shared Resources (Planned)
|
||||
|
||||
### Shared Packages
|
||||
- Common utilities and types
|
||||
- DBIS integration libraries
|
||||
- Authentication and authorization
|
||||
- Configuration management
|
||||
|
||||
### Shared Tooling
|
||||
- Build scripts
|
||||
- Testing frameworks
|
||||
- CI/CD pipelines
|
||||
- Documentation generators
|
||||
|
||||
---
|
||||
|
||||
## Development Workflow (Planned)
|
||||
|
||||
### Monorepo Tooling
|
||||
- **Package Manager**: pnpm workspaces (recommended) or npm/yarn
|
||||
- **Build Tool**: Turborepo or Nx (for build orchestration)
|
||||
- **Versioning**: Unified or independent versioning (TBD)
|
||||
|
||||
### Development Commands
|
||||
|
||||
```bash
|
||||
# Install dependencies for all projects
|
||||
pnpm install
|
||||
|
||||
# Build all projects
|
||||
pnpm build
|
||||
|
||||
# Test all projects
|
||||
pnpm test
|
||||
|
||||
# Lint all projects
|
||||
pnpm lint
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Projects
|
||||
|
||||
### DBIS Ecosystem
|
||||
- **[dbis_core](../dbis_core/)** - Core banking system
|
||||
- **[smom-dbis-138](../smom-dbis-138/)** - DBIS tenant blockchain
|
||||
- **[dbis_docs](../dbis_docs/)** - DBIS documentation
|
||||
|
||||
### OMNL Integration
|
||||
- OMNL integrates with DBIS infrastructure
|
||||
- Provides omniversal meta network layer services
|
||||
- Supports DBIS operations
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
Project-specific documentation is maintained in the OMNL submodule. Monorepo-level documentation will be added as the structure is developed.
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
When contributing:
|
||||
|
||||
1. Follow monorepo standards
|
||||
2. Coordinate with DBIS Tripartite Body members
|
||||
3. Update affected submodules
|
||||
4. Test integration with DBIS ecosystem
|
||||
5. Update documentation
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
[To be determined - will align with DBIS licensing]
|
||||
|
||||
---
|
||||
|
||||
## Status
|
||||
|
||||
**Current Status**: ✅ Active
|
||||
**Next Steps**:
|
||||
- Document OMNL project details
|
||||
- Define monorepo structure
|
||||
- Set up shared packages
|
||||
- Configure build tooling
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**DBIS Tripartite Body**: Elemental Imperium is 1/3 of the DBIS Tripartite Body
|
||||
|
||||
Reference in New Issue
Block a user