Home

Garp v3 Docs

Welcome to Garp! Garp is a framework and CMS built on top of Zend Framework.

Getting started

To start a Garp project on your machine, check out the Garp Scaffold project. It lets you setup a blank project using Composer's create-project.

• Detailed quickstart guide is here.
• Prerequisites

Garp on the command-line

Garp installs a g binary into vendor/bin. It helps you perform numerous tasks, such as asset distribution, cache clearing, adding users, shortcuts for git-flow or Amazon AWS.

Related reading:

• Command-line primer
• List of cli commands

Running Garp projects

The easiest way to start is to use our Docker configuration for Garp 3.

Upgrading from an old version?

• The changelog will tell you exactly what to do.

---

Documentation roughly grouped into meaningful sections:

Core

• Models
• Spawn — Model generator
• Routing
• Authentication
• REST API
• Images
• Snippets — Loose fragments of content
• Internationalisation — I18n
• Cache
• Command-line
• Utility
• Views
• Unit testing
• E2E testing
• A/B testing
• Functions

Modules

• CMS
• Forms
• Facebook
• Email
• Pagination
• Flash messages — Alerts
• Vimeo
• ExtJS

Meta

• Prerequisites
• Deployment
• Contributing
• Versioning
• Coding standards
• Setting up PHP CodeSniffer
• Running HTTPS locally
• Changelist
• Troubleshooting
• Migrating to Composer package
• Moving to .env configured setup

Frontend

Garp is not a front-end framework per se, but the Garp Scaffold is opinionated and contains a Gulpfile.js and some JS dependencies.

• Running Tasks with Gulp
• Recommended Javascript plugins