/gitpod-wordpress

Easily develop plugins and themes directly from your browser with Gitpod.

Primary LanguageShellMIT LicenseMIT

Gitpod for WordPress

Gitpod is a ready-to-code dev environment with a single click. It will allows you to develop plugin or theme directly from your browser.

Open in Gitpod

Features

Install

Just copy the .gitpod.yml and .gitpod.dockerfile to your project root directory and push to your remote repository.

  • If your project is a theme, change the wp-setup-plugin to wp-setup-theme in your .gitpod.yml.
  • By default, the webserver will use PHP v7.3. If you need a different version, change it on ENV PHP_VERSION in your .gitpod.dockerfile (line 4).

Also, the wp-setup-plugin (or wp-setup-theme) will search for a .init.sh file in your project root directory and execute it (if exists). Then, you can use the wp-cli to install plugins, install themes, and more. Or create your own tasks.

# .init.sh
wp plugin install woocommerce --activate # install WooCommerce
wp plugin activate ${REPO_NAME} # activate your plugin

Project dependencies (in composer.json or package.json) are automatically installed.

Usage

Now you access https://gitpod.io/#<url-of-your-github-project>.

Example: https://gitpod.io/#https://github.com/luizbills/wp-tweaks/

Your admin credentials:

username: admin
password: password

Utilities

  • You can use the following commands in terminal:

    • browse-url <endpoint>: open an endpoint of your WordPress installation.
    • browse-home: alias for browse-url / (your Homepage)
    • browse-wpadmin: alias for browse-url /wp-admin (WordPress Admin Painel)
    • browse-dbadmin: alias for browse-url /database (to manage your database with Adminer)
    • browse-phpinfo: alias for browse-url /phpinfo (a page with <?php phpinfo(); ?>)
    • browse-emails: open the MailHog client

  • You can setup your PHP on .htaccess file (eg: php_value max_execution_time 600)

Contributing

To contribute, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to your fork: git push origin <branch_name>
  5. Create the Pull Request.

Alternatively see the GitHub documentation on creating a pull request.

Just found a bug? Report it on GitHub Issues.

LICENSE

MIT © 2019 Luiz Paulo "Bills"

Made with ❤ in Brazil