Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@ AI-assisted development patterns. Each pattern is standalone - adopt what you ne

See [Quickstart](docs/quickstart.md) for pattern overview and adoption guidance.

## Development Setup

```bash
git clone https://github.com/ambient-code/reference.git
cd reference
./scripts/setup.sh
source .venv/bin/activate
pre-commit install
```

**Prerequisites**: Python 3.11+, Node.js (for markdownlint and mermaid-cli)

```bash
npm install -g markdownlint-cli @mermaid-js/mermaid-cli
```

## Repository Contents

```text
Expand Down
28 changes: 21 additions & 7 deletions scripts/setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,32 @@ fi
echo "Installing documentation dependencies..."
uv pip install -r requirements-dev.txt

# Verify installation
echo "Verifying installation..."
echo "✓ Documentation tooling installed"
# Install pre-commit hooks
echo "Installing pre-commit hooks..."
.venv/bin/pre-commit install

# Check for npm tools
echo ""
echo "Setup complete! 🎉"
echo "Checking npm tools..."
if command -v markdownlint &> /dev/null; then
echo "✓ markdownlint installed"
else
echo "⚠ markdownlint not found - install with: npm install -g markdownlint-cli"
fi

if command -v mmdc &> /dev/null; then
echo "✓ mermaid-cli installed"
else
echo "⚠ mermaid-cli not found - install with: npm install -g @mermaid-js/mermaid-cli"
fi

echo ""
echo "Setup complete!"
echo ""
echo "Next steps:"
echo " 1. Activate virtual environment: source .venv/bin/activate"
echo " 2. Explore documentation: cat docs/quickstart.md"
echo " 3. Validate Mermaid diagrams: ./scripts/validate-mermaid.sh"
echo " 4. Lint markdown: markdownlint docs/**/*.md --fix"
echo " 2. Install npm tools (if missing): npm install -g markdownlint-cli @mermaid-js/mermaid-cli"
echo " 3. Validate docs: pre-commit run --all-files"
echo ""
echo "For a working application demo, see:"
echo " https://github.com/ambient-code/demo-fastapi"
Expand Down
Loading