Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.92 KB

README.md

File metadata and controls

75 lines (49 loc) · 2.92 KB
Raw

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.

Features

Install

  1. Documentation on how to integrate github with GitPod - https://www.gitpod.io/docs/github-integration

  2. Install GitPod Chrome extenstion

  3. For clean WordPress instance

  • Just fork the repository and click on gitpod button appearing on github repository
  1. For theme and plugin
  • 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-core to wp-setup-theme or wp-setup-plugin in your .gitpod.yml.
  1. For theme and plugin, 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
wp theme activate ${REPO_NAME} # activate your theme

Usage

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

Example: https://gitpod.io/#https://github.com/ratnesh-kadam/gitpod-wordpress/

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(); ?>)

  • 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