/gitpod-laravel-starter

Configurable LAMP or LEMP stack starter project powered by Laravel and Gitpod. Supports Laravel 6, 7, and 8. Out of the box support for React, Vue, and Bootstrap frontends, with or without built-in auth .

Primary LanguageShellMIT LicenseMIT

Welcome

🚀 gitpod-laravel-starter generates a starting point for you to develop in the cloud with Laravel web application framework, MySql and pretty much any other technology you would like to add.

  • Supports Laravel 6, 7, and 8
  • Develop in the cloud on the Gitpod platform
  • Preconfigured yet fully customizable LAMP or LEMP stack
  • Full debugging capabilities
  • Preset frontends for React, Vue, and Bootstrap.
  • Auth scaffolding can be included with any preset frontend

If you want to jump right in to setting up a project then have a look at the wiki setup page.

The wiki is designed to provide you with essential details not found in this document such as how to easily add hot reloading and Typescript to your projects.

gitpod-laravel-starter is designed for any type of developer from beginner to professional to hobbyist. Developing in the cloud has many benefits including giving developers the freedom to try entire complex technological stacks with a single click.

Powered 100% by open source:

Gitpod - Spin up fresh, automated dev environments for each task, in the cloud, in secondsGitpod  Laravel - The PHP Framework for Web Artisans  PHP - A popular general-purpose scripting language that is especially suited to web development

MySQL Community Edition - Freely downloadable version of the world's most popular open source database  The Apache Software Foundation, Apache License 2.0 <http://www.apache.org/licenses/LICENSE-2.0>, via Wikimedia Commons  NGINX - A free, open-source, high-performance HTTP server and reverse proxy, as well as an IMAP/POP3 proxy server.

Bootstrap - Build fast, responsive sites with Bootstrap   Bash A Unix shell and command language written by Brian Fox for the GNU Project Vue.js - The Progressive JavaScript Framework   Bootstrap - Build fast, responsive sites with Bootstrap


Table of Contents

  1. Welcome
  2. Requirements
  3. Setting Up a Repository
  4. Running the Client
  5. Pushing Laravel scaffolding Files to Your Remote Repository
  6. Starter Project Configuration
  7. Gitpod Environment Variables
  8. Additional Features
  9. Debugging PHP
  10. Debugging JavaScript
  11. phpMyAdmin
  12. Generating a CHANGELOG.md Using github-changelog-generator
  13. Project Specific Bash Code and Package Installation
  14. Ruby Gems
  15. Git Aliases
  1. Deployment Outside of Gitpod
  2. Gitpod Caveats
  3. Thanks

Requirements

  • A GitHub account. You may use a free account.

  • A GitPod account. You may use a free account. Just log in with your github credentials.


Setting Up a Repository

There are many ways that you can use gitpod-laravel-starter. Full setup instructions can be found on the wiki setup page.

Creating a new Gitpod Workspace from a Github repository

Gitpod makes this easy. One simple URL deploys the entire system.

A detailed breakdown of the initialization phase can be found on the wiki initialization page

  • Paste your GitHub repository URL to the end of the special Gitpod URL: https://gitpod.io/#/.
  • If you don't need to push changes and you just want to try this repository with the default configuration you can click here Try it out on on Gitpod.io
  • Instructions for setting up a repository of your own can be found on the wiki setup page

Initializing the workspace will take between 2 to 5 minutes depending on how you have configured the starter.ini file. Subsequent starts or creation of a workspace from your repository will be much faster thanks to caching mechanisms.

When the workspace is created for the first time an entire online development environment complete with an IDE is deployed along with any additional installations you have set in starter.ini. Laravel scaffolding files and debugging capabilities are created the first time you build the workspace so you should push any new files to your repository before you get started developing your project. You can push the files with a single command: git new "Initial Commit"


Running the Client

A preview browser should automatically open and display the Laravel start page once the system is ready. This page is served by the default web server which is set in starter.ini. The code for the Laravel start page page is in /resources/views/welcome.blade.php. To manually open the preview browser or to refresh it you can run the command op.


Pushing Laravel scaffolding Files to Your Remote Repository

If the result log summary in the console shows success, then you should push those newly created Laravel scaffolding files to your remote repository before you get started coding your project.

Gitpod Account Permissions

You may need to allow Gitpod additional permissions to push to your repository in case you come across an issue like this one.

GitHub Email Protection

If your GitHub account uses the protected email feature and the email address you are using in your git configuration looks something like this:

3366792+myusername@users.noreply.github.com

you may encounter an error that looks something like this:

! [remote rejected] readme-dev -> readme-dev (push declined due to email privacy restrictions)

The easiest way to circumvent error is to uncheck the box labeled "Block command line pushes that expose my email" under Settings-->Emails in your GitHub account.

Another workaround is to edit the ~/.gitconfig file in your Gitpod workspace to use your protected email address since Gitpod defaults to using the unprotected email address for your GitHub account. Please note that if you do this you will have to make this change for every time you create a new workspace.


Starter Project Configuration

A configuration file has been provided to allow you to control many aspects of the development environment and the Laravel project scaffolding.

The file starter.ini in the root of the project allows you to configure optional installations and other various options. Have a look at the comments in starter.ini for details and acceptable values you can use. Simply change values in starter.ini, push those changes to your repository, create a new Gitpod workspace from that repository and your new configurations will be enabled. Some of the configurations you can make are:

  • Server: apache, nginx or php (development server)
  • Optional installations
    • phpMyAdmin
    • Frontend: react, vue or plain bootstrap
    • Your servers log monitor: tail with colorized log or multitail
    • .editorconfig: You can omit this file or use a less opinionated version of this file than what Laravel gives you by default
    • github-change-log-generator

Please note that a project's package.json can supercede any installation directives that have been set to zero in starter.ini.

Also please note that many of the configurations found in starter.ini should be made just once prior to creating your workspace for the first time. Have a look at the comments in starter.ini for specifics.

Preset Examples

gitpod-laravel-starter preset examples are auto-configured examples of React and Vue projects that you can learn from or use as starting points for your own projects.

You can initialize a preset example as a starting point by adding EXAMPLE=<id> to the Gitpod URL right after the # and followed by a /.

To use a preset example as a starting point:

  1. Setup a project repository
  2. Initialize your workspace using the workspace URL for your corresponding EXAMPLE id but substitute https://github.com/apolopena/gitpod-laravel-starter with your project repository URL.
  3. Save the system generated project scaffolding files to your new repository and you can start your project from that point.
    • Please that some directives in starter.ini such as phpmyadmin will not be supercded on subsequent initializations of your workspace. Edit your starter.ini as needed.
id Description Workspace URL
1 React Example with phpMyAdmin - Questions and Answers https://gitpod.io/#EXAMPLE=1/https://github.com/apolopena/gitpod-laravel-starter
2 React Example without phpMyAdmin - Questions and Answers https://gitpod.io/#EXAMPLE=2/https://github.com/apolopena/gitpod-laravel-starter
3 * React Typescript Example with phpMyAdmin - Questions and Answers https://gitpod.io/#EXAMPLE=3/https://github.com/apolopena/gitpod-laravel-starter
4 * React Typescript Example without phpMyAdmin - Questions and Answers https://gitpod.io/#EXAMPLE=4/https://github.com/apolopena/gitpod-laravel-starter
10 ** Vue Example with phpMyAdmin - Material Dashboard https://gitpod.io/#EXAMPLE=10/https://github.com/apolopena/gitpod-laravel-starter
11 ** Vue Example without phpMyAdmin - Material Dashboard https://gitpod.io/#EXAMPLE=11/https://github.com/apolopena/gitpod-laravel-starter


* Comes with hot reload functionality
** Not designed to run in an iframe such as the preview browser in the IDE.

Development Servers

gitpod-laravel-starter project comes pre-packaged with three development servers that serve on the following ports:

  • Apache: port 8001
  • Nginx (with php-fpm): port 8002
  • PHP Development Sever: port 8000

By default the server set in starter.ini will be the server used. You can run any server at the same time or change your default server in starter.ini at any time.

Please note that Laravel uses the APP_URL and ASSET_URL variables set in .env to serve content. These values are set during workspace initialization and are based on the default server you are using. If you want serve the project using a different server after a workspace has been created, then you will need to change APP_URL and ASSET_URL in .env to have the port number in it for the server you want to use.

You may also run the PHP Development server manually via the command php artisan serve which will use port 8000.

The default server will be started automatically when the workspace is started.

You can toggle any server on and off from any terminal window by running the relevant command. These commands will also dynamically kill the log monitor process for that server:

  • Apache: start_apache or stop_apache
  • Nginx start_nginx or stop_nginx
  • PHP built-in development server: start_php_dev or stop_php_dev

Changing the Default Server

Change the value of default_server in the development section of starter.ini to apache, nginx, or php. You will need to change the APP_URL and ASSET_URL in the .env file to use the port number for that server if you change the default development server after a workspace has been created.

Running More Than one Server at a Time

You may start and stop multiple servers.

If you have the Apache server running and you want to run the Nginx server at the same time just run this command:

start_nginx

The Nginx server will now be running in addition to the Apache server.

Laravel requires a URL to be set in the .env file in the project root. This is done for you automatically when the workspace is initialized. The URL set in the .env file contains the server port. so if you want to properly serve Laravel pages from a server other than the default server you initialized the project with then will need to change the values for APP_URL and ASSET_URL accordingly.

Changing the PHP version and PPA

In starter.ini there is a [PHP] section and directives to change the version of PHP and or the ppa used for downloading the PHP packages.


Note: See starter.ini for more details.

The following values are supported in the [PHP] section of starter.ini:

  • version
    • 7.4
      • The default value
      • Installs PHP 7.4. See php.sh for specifics.
      • The current version of PHP that gitpod installs by default in their workspace-full image will be automatically purged.
    • gitpodlatest
      • This keeps the current version that gitpod installs by default in their workspace-full image.
  • ppa
    • OS
      • The default value
      • Uses the standard Debian distribution ppa
    • ondrej
      • Uses ppa:ondrej/php. This ppa is maintained by an individual but does support the of running multiple versions of PHP side by side.

Changing the Laravel Version

In starter.ini there is a directive to change the version of Laravel. You should only change the version of Larvel before you create a new workspace. The laravel version directive is cached in the workspace image so changing it sometimes requires you to break the Docker cache

Important:

  • By default gitpod-laravel-starter uses the most recent version of Laravel. Currently the most recent version of Laravel is 8.*
  • There are exactly three supported values for the Laravel version directive: 8.*, 7.*, and 6.*
  • Laravel will always use the most recent/stable minor and patch version for any major version.

Caveats:

  • Upgrading or downgrading Laravel once Laravel scaffolding files have been saved to your repository is not advised and should be avoided.
  • Attempts to upgrade will will result in an automatic downgrade and could cause instability.
  • Attempts to downgrade will be ignored and could cause instability.
  • The Laravel version directive is cached in the workspace image so changing it requires you to break the Docker cache.

Breaking the Docker cache

You can break the Docker cache and force the workspace image to be rebuilt by incrementing the INVALIDATE_CACHE variable in .gitpod.Dockerfile. Push the changed .gitpod.Dockerfile to your repository, create a new gitpod workspace and the workspace image will be rebuilt. Any cached external files that Docker uses such as starter.ini will be updated.


Gitpod Environment Variables

The following features can be enabled through environment variables that have been set in your Gitpod preferences.:
* Please note that storing sensitive data in environment variables is not ultimately secure but should be OK for most development situations.

  • Sign Git commits with a GPG key

    • GPG_KEY_ID (required)
      • The ID of the GPG key you want to use to sign your git commits
    • GPG_KEY (required)
      • Base64 encoded private GPG key that corresponds to your GPG_KEY_ID
    • GPG_MATCH_GIT_TO_EMAIL (optional)
      • Sets your git user.email in ~/.gitconfig to the value provided
    • GPG_AUTO_ULTIMATE_TRUST (optional)
      • If the value is set to yes or YES then your GPG_KEY will be automatically ultimately trusted

  • Activate an Intelliphense License Key

    • INTELEPHENSE_LICENSEKEY
      • Creates ~/intelephense/licence.txt and will contain the value provided
      • This will activate Intelliphense for you each time the workspace is created or restarted

Additional Features

To keep the gitpod-laravel-framework as flexible as possible, some features have been left out of the starter.ini configuration file. These additional features can be easily added to your project using a one-time set up process. Wiki pages are available for each additional feature below that you may want to add to your project. Some of these features are automatically enabled for certain preset examples.

Hot Reloading

  • gitpod-laravel-starter makes it easy for you to add the ability to see your code changes in realtime without refreshing the browser. Take a look at the wiki hot reload page for more details.

Typescript


Debugging PHP

Debugging must be enabled before breakpoints can be hit and will last for an hour before the debug session is disabled automatically.

When debugging is enabled or disabled, the preview browser will reload the index page. When debugging is enabled, each subsequent request can be debugged for an hour or until debugging is disabled.

This system uses port 9009 for the debugging. A launch configuration file is included in .vscode/launch.json and in .theia/launch.json.

The Default Development Server

To enable a debugging session on the default development server run debug_on in a Gitpod terminal. To disable a debugging session on the default development server run debug_off in a Gitpod terminal.

Specific Development Servers

You can toggle a debugging session for a specific server:

  • Apache
    • debug_on apache or debug_off apache
  • Nginx
    • debug_on nginx or debug_off nginx
  • PHP (development server)
    • debug_on php or debug_off php

The hot reload webpack server on port 3005 is not supported by this debugging system. You may be able to configure it on your own if you like.

Setting Breakpoints

Set a breakpoint in the Gitpod IDE by clicking in the gutter next to the line of code you want in any PHP file in the public folder (or deeper)

Then in the Gitpod IDE in the browser:

  1. Click the debug icon in the left side panel to open the Debug panel.
  2. Choose "Listen for XDebug" from the dropdown list.
  3. Click the green play button (you should see the status "RUNNING" in the CALL STACK panel)
  4. Refresh the preview browser either manually or by running the op command and your breakpoint will be hit in the IDE.

All debugging is subject to a server timeout, just refresh preview browser or run the command op if this happens.

Debugging Blade Templates

You may also debug blade templates by placing the following snippet above where you want to inspect the blade directive.

<?php xdebug_break(); ?>

Save the file and refresh the preview browser when the debugger is in the IDE.

This will open a temporary PHP file that has all the blade directives converted to php tags, you may set additional breakpoints in this code as well. Do not edit the code in these temporary files as it they be disposed at any time and are only derived for the current debugging session.

If you are having trouble, launch the "Listen for Xdebug" launch configuration again and refresh the preview browser.


Tailing the Xdebug Log

You may want to see how Xdebug is working with your server when you are debugging PHP files.

  1. Open a new terminal in gitpod
  2. Run the command: tail -f /var/log/xdebug.log

Debugging JavaScript

The is a rather diverse topic. To make a long story short it is possible but very situational.

Have a look at the wiki debugging JavaScript page for details and exact steps you can take to debug various types of JavaScript.


phpMyAdmin

phpMyAdmin is a tool that handles MySQL administration over the web. This tool is very powerful and can be essential when developing MySQL powered systems especially in the cloud. For more information on what phpMyAdmin can do, check out the official documentation, the user guide or just dabble around on the demo server.

Installing phpMyAdmin

phpMyAdmin is installed automatically by default. A phpMyAdmin installation directive is available in starter.ini that allows you to omit the installation if you like.

Security Concerns

phpMyAdmin also introduces some extra security concerns that you may want to address. If you have installed phpMyAdmin using the install directive in starter.ini then by default, two MySQL accounts are created using default passwords stored in version control:

  • pmasu: This is the 'super user' account that a developer can use to log into phpMyAdmin in order to administer any MySQL database.
    • The default password for the user pmasu is: 123456
  • pma: This is the 'control user' that the phpMyAdmin uses internally to manage it's advanced storage features which are enabled by default. This user can only administer the phpmyadmin database and should not be used by anyone.
    • The default password the 'control user' pma is: pmapass

Securing phpMyAdmin

At a minimum the default passwords that phpMyAdmin uses to administer the MySQL databases should be changed right after a Gitpod workspace has been created for the first time. An update-phpmyadmin-pws command has been provided that automagically changes the default passwords for you.

The following steps are required to successfully run the update-phpmyadmin-pws command:

  1. Create a file in .gp named .starter.env. You can run this command from the project root: cp .gp/.starter.env.example .gp/.starter.env
  2. Or Copy and paste all the keys containing PHPMYADMIN from .gp/.starter.env.example to your blank .starter.env file
  3. In .starter.env, set your password values for the PHPMYADMIN keys and save the file
  4. In a terminal run the alias: update-phpmyadmin-pws

Generating a CHANGELOG.md Using github-changelog-generator

Keeping track of your changes and releases can easily be automated. There is an option in starter-ini to install github-changelog-generator. This option is on by default and additional settings for this option can be found in starter.ini. You can generate a CHANGELOG.md by running the command: rake changelog Currently generating a changelog can only be done when the workspace is built for the first time. See here for more details. See github-changelog-generator for documentation.

Setting up an Access Token for github-changelog-generator

GitHub limits API calls unless using an access token. github-changelog-generator uses the GitHub API to generate a CHANGELOG.md and will quickly max out of API calls if you try to generate the CHANGELOG.md more than a few times in a certain period of time. It is recommended that you setup an access token from your GitHub account and then set that access token in an environment variable via your Gitpod dashboard. This way any project you like can generate a CHANGELOG.md as many times as it likes without error.

  1. You can generate an access token here. If the repository is public you do not need to grant any special privileges, just generate the token and copy it to your clipboard. Otherwise if the repository is private you need to grant it 'repo' privileges.
  2. Once you have the github access token copied to your clipboard, in your gitpod account go to settings in the Environment Variables section click the "Add Variable" button.
  3. For the 'name' field value type in CHANGELOG_GITHUB_TOKEN
  4. For the 'value' field paste in your github access token
  5. For the 'Organization/Repository' field you may leave it as it or type in GITHUBUSERNAME/* where GITHUBUSERNAME is the user name of your github account. This will allow you to use the github-changelog-generator as many times as you like for any of your repositories.
  6. Restart or create a new workspace and you will now be able to use github-changelog-generator via the rake changelog command as many times as you like.

Important Note: If you do not generate an access token for github-changelog-generator, and if you do not cancel the error that results when you exceed your Github API calls when using github-changelog-generator then you could potentially run out of space for your github workspaces and not be able to create any any new workspace or open any existing ones until you delete the offending workspace(s) or the system is cleared automatically.


Project Specific Bash Code and Package Installation

Most of the files in gitpod-laravel-starter are core files and should not be altered unless you open PR for gitpod-laravel-starter however some files are provided so that you can customize your project even further.
You are encouraged to put your project specific code in files mentioned below:

User Editable Files

  • .gp/bash/init-project.sh
    • Contains some basic scaffolding and examples that you may use in your project.
    • Bash code you would like to run when a workspace is created for the first time (initialization) should added here.
  • .gp/bash/install-project-packages.sh
    • Packages that you would like installed (via apt-get) when the docker image layers are built can be added as a single space delimited string to this file.
    • Any changes made to .gp/bash/install-project-packages.sh will require a rebuild of the Docker image layers before the workspace is created for the first time.
    • To rebuild the Docker image layers increment the INVALIDATE_CACHE value in .gitpod/Dockerfile and push that change to the remote repository

Migration and Seeding

It is recommended that you migrate and seed your project in this file: .gp/bash/init-project.sh.
For example, the react preset makes use of .gp/bash/init-project for migration and seeding.

Ruby Gems

Currently until gitpod fixes the issue of ruby gems not persisting across workspace restarts, you can only use rake commands when the workspace is created for the first time.


Git Aliases

Git aliases that you would like to add to your project should be added to the alias file.

Emoji-log and Gitmoji

A compilation of git aliases from Emoji-log and Gitmoji are included, use them as you like from the command line. There is also a separate set of emoji based git aliases that will commit the files with a message and push them to the repository without adding the files. Use these aliases for dealing with groups of files that need different commit messages but still need to use to Emoji-log and or Gitmoji standards. You can get a list of all the emoji based git aliases with the command: git a


Deployment Outside of Gitpod

For now this will be something you need to figure out, eventually some guidelines for how to do that may be added here.


Gitpod Caveats

Gitpod is an amazing and dynamic platform however sometimes during it's peak hours, latency can affect the workspace. Here are a few symptoms and their possible remedies. This section will be updated or removed as Gitpod evolves.

  • Symptom: Workspace loads, IDE displays, however one or more terminals are blank.
  • Symptom: Workspace loads, IDE displays, however no ports become available and or the spinner stays spinning in the terminal even after a couple of minutes.
    • Possible Fix: Refresh the browser

You can also try to remedy any rare Gitpod network hiccups by simply waiting 30 minutes and trying again.

Thank You

🙏 to the communities of:

  • Gitpod
  • Laravel
  • VS Code
  • Xdebug