Setting up Flynt

Requirements

Before you can get started with Flynt, there are some requirements that need to be met on your local machine. To make things easier you can use tools such as Trellis or Scotchbox and skip directly to Creating a Flynt project. If you want to set up your environment manually, keep reading.

The following tools and versions are required for Flynt to work correctly. Other versions than the ones listed here are not explicitly tested and may or may not work with Flynt.

Command Line

These tools must be available in your system’s PATH environment.

Command Line Tool Version
Node >= 6.0
Composer >= 1.2
Yarn* >= 0.21
PHPCS** >= 2.5

*You can use npm as well, but Yarn is strongly recommended.
**Not strictly required, but strongly recommended.

Server

Requirement Version
PHP >= 5.6
MySQL >= 5.6

Additionally, you will need a way to manage your virtual host setup. This can be done either manually via a hosts file or with tools like Mamp Pro.

Creating a Flynt Project

As soon as you have your environment set up, follow the steps below to create a new Flynt project.

  1. Using the command line, install the Flynt CLI:

    yarn global add @flyntwp/flynt-cli
    
  2. Run the create command and follow the instructions:

    flynt create
    
  3. Set up the virtual host provided during step 2 and you’re good to go!

Resources / Next Steps

  1. Learn how to develop your first simple Flynt component in 6 steps.
  2. Get an understanding of the Flynt Ecosystem.
  3. If you are stuck or having issues setting up Flynt, leave an issue on GitHub for further assistance: