64bf2e281e
- Add Makefile for make-based workflow - Add setup.sh / setup.bat for one-command bootstrap - Add scripts/install-deps.sh for macOS/Linux dependencies - Add scripts/install-deps.ps1 for Windows (Chocolatey) - Add scripts/install-core.sh to build/download core CLI - Add scripts/install-core.ps1 for Windows - Update README with installation instructions Developers can now run: macOS/Linux: ./setup.sh (or make setup) Windows: .\setup.bat (as Admin) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
96 lines
2.3 KiB
Markdown
96 lines
2.3 KiB
Markdown
# Host UK Developer Workspace
|
|
|
|
This repository bootstraps a complete Host UK development environment.
|
|
|
|
## Quick Start
|
|
|
|
### One-liner (macOS/Linux)
|
|
```bash
|
|
git clone git@github.com:host-uk/core-devops.git && cd core-devops && make setup
|
|
```
|
|
|
|
### Step by step
|
|
```bash
|
|
# 1. Clone this repo
|
|
git clone git@github.com:host-uk/core-devops.git
|
|
cd core-devops
|
|
|
|
# 2. Install dependencies and core CLI
|
|
make setup
|
|
|
|
# Or manually:
|
|
./scripts/install-deps.sh # Install go, gh, php, node, etc.
|
|
./scripts/install-core.sh # Build and install core CLI
|
|
|
|
# 3. Start developing
|
|
cd packages/core-php
|
|
composer install
|
|
```
|
|
|
|
### Windows (PowerShell as Admin)
|
|
```powershell
|
|
git clone git@github.com:host-uk/core-devops.git
|
|
cd core-devops
|
|
.\scripts\install-deps.ps1 # Install via Chocolatey
|
|
.\scripts\install-core.ps1 # Build and install core CLI
|
|
core setup # Clone all repos
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
Run `core doctor` to check your environment. You'll need:
|
|
|
|
- **Git** - Version control
|
|
- **GitHub CLI** (`gh`) - For issues, PRs, CI status
|
|
- **PHP 8.3+** - Laravel packages
|
|
- **Composer** - PHP dependencies
|
|
- **Node.js 20+** - Frontend builds
|
|
- **pnpm** - Package manager (preferred over npm)
|
|
|
|
Optional but recommended:
|
|
- **Claude Code** - AI-assisted development
|
|
- **Docker** - For FrankenPHP runtime
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
core setup # Clone all repos into packages/
|
|
core setup --only foundation,module # Clone specific types
|
|
core doctor # Check environment health
|
|
core doctor --fix # Attempt to fix issues
|
|
|
|
# Once set up, standard core commands work:
|
|
core health # Status summary
|
|
core work # Commit and push workflow
|
|
core issues # View GitHub issues
|
|
```
|
|
|
|
## Structure
|
|
|
|
```
|
|
core-devops/
|
|
├── packages/ # Cloned repositories (git-ignored)
|
|
│ ├── core-php/
|
|
│ ├── core-tenant/
|
|
│ └── ...
|
|
├── repos.yaml # Package registry
|
|
└── README.md
|
|
```
|
|
|
|
## Updating
|
|
|
|
```bash
|
|
core pull # Pull updates for all repos
|
|
core pull --all # Pull even if not behind
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
**"core: command not found"**
|
|
Install the Core CLI from https://github.com/Snider/Core
|
|
|
|
**"gh: command not found"**
|
|
Install GitHub CLI: `brew install gh` then `gh auth login`
|
|
|
|
**Clone failures**
|
|
Check your SSH keys: `ssh -T git@github.com`
|