Home

Welcome to the Cuttlefish documentation wiki!

Basic Workflow

1. Installation
2. Configuration
3. Add content

Navigation: milestones

Installation

Framework requirements:

• Composer 2
• PHP 7.4

For example, these can be installed using Homebrew via brew install php@7.4 composer

Assuming those are installed, on a fresh project you can require the framework composer require svandragt/cuttlefish or download a zip from an example project such as cuttlefish/blog and start making changes.

Contributors

Start working on Cuttlefish by checking out the repository and:

• psh To start a shell with the right tooling activated.
• phive Installs PHP linting.

then

$ git clone https://github.com/svandragt/cuttlefish && cd cuttlefish
$ composer setup

Running the project

$ composer serve
> php -S localhost:8080 -t site/www/
[Sun Jul  4 21:30:01 2021] PHP 7.4.20 Development Server (http://localhost:8080) started

Open localhost:8080 in the browser!

Troubleshooting

There are no known issues.

Next step

Continue with the site configuration.