78 lines
2.1 KiB
Markdown
78 lines
2.1 KiB
Markdown
|
|
# Setting Up as Git Submodule
|
||
|
|
|
||
|
|
This directory has been initialized as a git repository and can be set up as a submodule of the parent proxmox repository.
|
||
|
|
|
||
|
|
## Option 1: Create Remote Repository First
|
||
|
|
|
||
|
|
1. **Create a new repository** on your git hosting service (GitHub, GitLab, etc.)
|
||
|
|
- Repository name: `dbis-arbitrage` (or your preferred name)
|
||
|
|
- Keep it empty (no README, no .gitignore)
|
||
|
|
|
||
|
|
2. **Add remote and push**:
|
||
|
|
```bash
|
||
|
|
cd dbis_core/src/core/defi/arbitrage
|
||
|
|
git remote add origin <your-repo-url>
|
||
|
|
git add .
|
||
|
|
git commit -m "Initial commit: Deal orchestration tool"
|
||
|
|
git push -u origin main
|
||
|
|
```
|
||
|
|
|
||
|
|
3. **Add as submodule in parent repository**:
|
||
|
|
```bash
|
||
|
|
cd /home/intlc/projects/proxmox
|
||
|
|
git submodule add <your-repo-url> dbis_core/src/core/defi/arbitrage
|
||
|
|
git commit -m "Add arbitrage tool as submodule"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Option 2: Use Existing Local Repository
|
||
|
|
|
||
|
|
If you want to keep it as a local git repository without a remote:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd dbis_core/src/core/defi/arbitrage
|
||
|
|
git add .
|
||
|
|
git commit -m "Initial commit: Deal orchestration tool"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Option 3: Remove Git and Keep as Regular Directory
|
||
|
|
|
||
|
|
If you don't want it as a submodule:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd dbis_core/src/core/defi/arbitrage
|
||
|
|
rm -rf .git
|
||
|
|
```
|
||
|
|
|
||
|
|
## Current Status
|
||
|
|
|
||
|
|
- ✅ Git repository initialized
|
||
|
|
- ✅ .gitignore created
|
||
|
|
- ✅ package.json created
|
||
|
|
- ✅ README.md created
|
||
|
|
- ✅ README_SUBMODULE.md created (comprehensive documentation)
|
||
|
|
- ⏳ Ready for initial commit
|
||
|
|
- ⏳ Ready to be added as submodule
|
||
|
|
|
||
|
|
## Files Included
|
||
|
|
|
||
|
|
- `types.ts` - Type definitions
|
||
|
|
- `config.ts` - Configuration
|
||
|
|
- `risk-control.service.ts` - Risk management
|
||
|
|
- `step-execution.service.ts` - Step implementations
|
||
|
|
- `redemption-test.service.ts` - Redemption testing
|
||
|
|
- `deal-orchestrator.service.ts` - Main orchestrator
|
||
|
|
- `cli.ts` - CLI interface
|
||
|
|
- `index.ts` - Exports
|
||
|
|
- `README.md` - Quick start guide
|
||
|
|
- `README_SUBMODULE.md` - Comprehensive documentation
|
||
|
|
- `package.json` - Package configuration
|
||
|
|
- `.gitignore` - Git ignore rules
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
1. Review and customize `package.json` if needed
|
||
|
|
2. Add remote repository URL
|
||
|
|
3. Make initial commit
|
||
|
|
4. Push to remote
|
||
|
|
5. Add as submodule to parent repository
|