create-project

Initializer for (private) gotoAndPlay starter projects.

Run npm init @gotoandplay/project <folder>. This will initialize the starter project in <folder>, which defaults to your current working directory.

You will be asked the following questions:

• What type of project do you need?

  A predefined choice question - determines the starter project you want. Possible choices:

  • wordpress
  • react

• What version do you want to start from?

  A predefined choice question - determines the version of starter project to check out. Possible choices:

  • <latest-tag> - Latest released version.
  • canary - Latest unreleased commit. Use at your own risk. Note that the initializer may be incompatible with unreleased changes.

• What's the name of your project?

  This will be your package name, so it is validated against npm's rules. Defaults to the folder name.

• Describe your project in a few words:

  This will be saved in package.json, composer.json (for wordpress project type) and README.

• What's your remote repository URL? (optional)

  This should be in the SSH format, e.g. [email protected]:gtap-dev/base-project.git.

• What's your gotoAndPlay Composer Repository API key (wordpress-only)

  Your personal gotoAndPlay Composer Repository API key. Ask your boss if confused.

Note that since the script tries to clone a private repository, you need to authenticate before. For example, to load your SSH key, run start-ssh-agent before the create command.