Update CI workflow and README for submodule support
- Update CI workflow to checkout submodules recursively - Update README with submodule cloning instructions - Add project structure notes about submodules - Create comprehensive review summary document
This commit is contained in:
21
README.md
21
README.md
@@ -76,10 +76,14 @@ ASLE is a comprehensive DeFi liquidity infrastructure platform combining:
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Clone the repository**
|
||||
1. **Clone the repository with submodules**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
# Clone with submodules (recommended)
|
||||
git clone --recurse-submodules <repository-url>
|
||||
cd asle
|
||||
|
||||
# Or if already cloned, initialize submodules
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
2. **Set up environment variables**
|
||||
@@ -122,14 +126,21 @@ npm run dev
|
||||
|
||||
```
|
||||
asle/
|
||||
├── contracts/ # Smart contracts (Foundry)
|
||||
├── backend/ # Node.js API server
|
||||
├── frontend/ # Next.js application
|
||||
├── contracts/ # Smart contracts (Foundry) - Git submodule
|
||||
├── backend/ # Node.js API server (monorepo)
|
||||
│ ├── src/api/ # REST API routes
|
||||
│ ├── src/middleware/# Express middleware
|
||||
│ ├── src/jobs/ # Background jobs/orchestration
|
||||
│ └── src/services/ # Business logic services
|
||||
├── frontend/ # Next.js application - Git submodule
|
||||
├── mobile/ # React Native mobile app
|
||||
├── docs/ # Documentation
|
||||
├── scripts/ # Utility scripts
|
||||
└── .github/ # CI/CD workflows
|
||||
```
|
||||
|
||||
**Note:** `contracts/` and `frontend/` are git submodules. See [SUBMODULE_SETUP.md](./SUBMODULE_SETUP.md) for details.
|
||||
|
||||
For detailed structure, see [PROJECT_STRUCTURE.md](./PROJECT_STRUCTURE.md)
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
Reference in New Issue
Block a user