Developer Docs

# Clone a project
git clone https://github.com/circuvent-technologies/nexus-ai-os.git
cd nexus-ai-os

# Install dependencies
npm install        # or yarn / pnpm install

# Set up environment
cp .env.example .env
# Edit .env with your configuration

# Start development server
npm run dev

# Or start with Docker
docker-compose up -d

project-root/
├── README.md              # Project overview, setup guide
├── ARCHITECTURE.md         # System design documentation
├── CONTRIBUTING.md         # Contribution guidelines
├── LICENSE                 # MIT License
├── .env.example            # Environment template
├── .gitignore
├── docker-compose.yml      # Docker deployment
├── Dockerfile              # Container build
│
├── src/                    # Source code
│   ├── app/                # Next.js App Router pages
│   ├── components/         # React components
│   ├── hooks/              # Custom React hooks
│   ├── lib/                # Utilities, data, configs
│   └── types/              # TypeScript interfaces
│
├── public/                 # Static assets
├── docs/                   # Extended documentation
├── tests/                  # Test files
└── scripts/                # Build/deploy scripts

# 1. Create a feature branch
git checkout -b feature/new-feature

# 2. Make changes and test
npm run dev          # Start dev server
npm run lint         # Check code style
npm run type-check   # TypeScript validation

# 3. Commit with conventional commits
git add .
git commit -m "feat(component): add new feature"

# 4. Push and create PR
git push origin feature/new-feature
# Create PR on GitHub with description

# 5. After review and merge
git checkout main
git pull origin main