[AIR-3][AIS-3][BPC-3][RES-3]
Development Setup Guide¶
Overview¶
Add a brief overview of this document here.
Table of Contents¶
Prerequisites¶
Required Software¶
- Rust (latest stable)
- Node.js (16.x or later)
- Python (3.8 or later)
- Docker Desktop
Development Tools¶
- VS Code with recommended extensions
- Rust Analyzer
- Git (2.x or later)
Initial Setup¶
- Clone Repository
bash
git clone --recursive https://github.com/botshelomokoka/anya.git
cd anya
- Install Dependencies
```bash # Rust dependencies cargo build
# Node.js dependencies npm install
# Python dependencies pip install -r requirements.txt ```
- Environment Configuration
bash
cp .env.example .env
# Edit .env with your settings
Repository Management¶
Repository Structure¶
anya/
├── core/ # Core Anya functionality
├── dash33/ # Dashboard submodule
├── enterprise/ # Enterprise integration
├── mobile/ # Mobile application
└── docs/ # Documentation
Submodule Management¶
## Initialize and update all submodules
git submodule update --init --recursive
## Update specific submodule
git submodule update --remote [submodule-name]
## Track submodule branches
git submodule foreach git checkout main
Documentation Tracking¶
Each repository maintains its own documentation under docs/
:
- anya/docs/
: Core documentation
- dash33/docs/
: Dashboard-specific docs
- enterprise/docs/
: Enterprise integration docs
- mobile/docs/
: Mobile application docs
To maintain consistency: 1. Use relative links between docs 2. Follow the standard structure 3. Update cross-repository references
Development Workflow¶
Branch Management¶
graph LR
A[main] --> B[development]
B --> C[feature branches]
C --> B
B --> A
Testing¶
- Unit Tests
bash
cargo test
- Integration Tests
bash
cargo test --test '*'
- End-to-End Tests
bash
./scripts/e2e-tests.sh
Deployment¶
Local Development¶
cargo run
Production Build¶
cargo build --release
Troubleshooting¶
Common Issues¶
- Submodule initialization
- Dependency conflicts
- Environment configuration
Support¶
- GitHub Issues
- Development Chat
- Documentation