Quick start - PhpGt/WebEngine GitHub Wiki

Install

For alternative installation instructions, see the installation page.

Automated installer

The automated installer will get your computer set up automatically and enable the gt commands in your terminal. It will explain what it is doing before each step. To run it, paste this into your Bash terminal:

curl https://install.php.gt | bash

Important! Never run the automated installer on a production server. Piping a command from the internet into your bash prompt could be used by a malicious user as a vector of attack. Even on a development computer it is a good idea to inspect the install script before executing. You can do this in three steps:

  1. wget https://install.php.gt -O install.sh
  2. less install.sh
  3. bash install.sh

Once you can type gt to get a list of available commands, you're ready to go.

Create new project

To start a new project, use the gt create command. Syntax for this command is gt create DIRECTORY [--blueprint BLUEPRINT] [--namespace NAMESPACE]. The create command will create a new project in the directory specified, and use the optionally supplied blueprint name to base the project from. Specifying no blueprint will create an empty WebEngine application.

For example: gt create MyBlog --blueprint blog will create a new WebEngine application within the MyBlog directory, based off of the blog blueprint. A list of blueprints is available here: https://www.php.gt/blueprints .

Read more about Blueprints.

Run your project

When you have a project created, the gt run command runs a local server available at http://localhost:8080 by default. The run command concurrently runs the client-side build scripts and cron scripts, which are necessary for serving your application locally with full functionality.

Read more in the running your application section.