jfraeysd/fetch_ml
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
fetch_ml/docs/src/development-setup.md
Jeremie Fraeys 385d2cf386 docs: add comprehensive documentation with MkDocs site 
- Add complete API documentation and architecture guides
- Include quick start, installation, and deployment guides
- Add troubleshooting and security documentation
- Include CLI reference and configuration schema docs
- Add production monitoring and operations guides
- Implement MkDocs configuration with search functionality
- Include comprehensive user and developer documentation

Provides complete documentation for users and developers
covering all aspects of the FetchML platform.
2025-12-04 16:54:57 -05:00

1.1 KiB
Raw Blame History

Development Setup

Set up your local development environment for Fetch ML.

Prerequisites

Container Runtimes:

  • Docker Compose: For testing and development only

  • Podman: For production experiment execution

  • Go 1.21+

  • Zig 0.11+

  • Docker Compose (testing only)

  • Redis (or use Docker)

  • Git

Quick Setup

# Clone repository
git clone https://github.com/jfraeys/fetch_ml.git
cd fetch_ml

# Start dependencies
see [Quick Start](quick-start.md) for Docker setup redis postgres

# Build all components
make build

# Run tests
see [Testing Guide](testing.md)

Detailed Setup

Quick Start

git clone https://github.com/jfraeys/fetch_ml.git
cd fetch_ml
see [Quick Start](quick-start.md) for Docker setup
make build
see [Testing Guide](testing.md)

Key Commands

  • make build - Build all components
  • see [Testing Guide](testing.md) - Run tests
  • make dev - Development build
  • see [CLI Reference](cli-reference.md) and [Zig CLI](zig-cli.md) - Build CLI

Common Issues

  • Build fails: go mod tidy
  • Zig errors: cd cli && rm -rf zig-out zig-cache
  • Port conflicts: lsof -i :9101