Requirements

This tutorial will utilize the DDEV PHP developer environment, so any system that meets its requirements should be sufficient here.


Fundamental Requirements

  • Docker
  • Git
  • DDEV

Setting Up

First, clone the AntCMS source code and move into the root directory.

git clone https://github.com/AntCMS-org/AntCMS.git
cd AntCMS

Next, you'll want to start the DDEV container for AntCMS.

ddev start

Assuming you ran into no errors, you should now find your AntCMS developer instance available at https://antcms.ddev.site.


Using the AntCMS CLI With DDEV

For convenience, the AntCMS CLI is mapped to a command named antcli inside DDEV, with autocomplete provided for the default AntCMS commands. Custom commands will work without issue, but they do not currently support autocomplete.

Examples

  • ddev antcli clearCache will empty the AntCMS cache.
  • ddev antcli initExample will download and load example content into your AntCMS installation, replacing whatever is there now.

Running Tests

ddev composer test

Fixing the Code Style

ddev composer run-cs