Setup

Getting Started

There are 3 main ways to use gitpod-laravel-starter all of which require a gitpod account and depend on your use-case.

• The Curious
  • You just want to see how gitpod-laravel-starter works without creating a project of your own. You don't need change, add or push files to a respository.
• The Developer
  • You would like to build one or more projects in your own repository using gitpod-laravel-starter as the starting point.
• The Dabbler
  • You don't need to build a real project of your own and you don't mind working with a single fork. You would like to expirement with various configurations, add the project scaffolding to your repository but that is the extent of it.

The Curious

This is the quickest way to start but also the most limited as you will not be able to make any changes.

Default 'Vanilla' setup with phpMyAdmin

'Questions and Answers' example using React and Bootstrap

(without phpMyadmin)

(with phpMyadmin)

Material Dashboard example using Vue and Bootstrap

(without phpMyadmin)

(with phpMyadmin)

The Developer

This is the best option if you want to create as many projects as you wish, name, configure and build upon them as you like.

Clone the gitpod-laravel-starter into a new project directory, delete the git history, initialize it, and push it to a new respository of your own. By doing this you can start a project with whatever name you like and clean history.

Gitpod will use the name of your GitHub repository as the Laravel project name so make sure you name your project repository accordingly.

Handy Functions

If you need to setup new projects frequently you can use these functions:

• Bash
  • create a new project or create a new project from a branch
• Zsh functions
  • create a new project
  • create a new project from a branch

Otherwise use the steps below

Create a new project repository from gitpod-laravel-starter

1. Make a new repository using your GitHub account.
2. On your local machine copy and paste the below one-liner command into your terminal.
   • Make sure you replace the PLACEHOLDER values with your GitHub user name and your new GitHub repository name

__new_repo_project_name=PLACEHOLDER; __github_username=PLACEHOLDER; mkdir "$__new_repo_project_name" && cd "$__new_repo_project_name" && git clone https://github.com/apolopena/gitpod-laravel8-starter.git . && rm -rf .git && git init && git add -A && git commit -m "initial commit built from https://github.com/apolopena/gitpod-laravel8-starter" && git remote add origin "https://github.com/$__github_username/$__new_repo_project_name.git" && git branch -m main && git push -u origin main

Create a new project repository from a branch of gitpod-laravel-starter

You may also create a new project from a branch of gitpod-laravel-starter by using the below one-liner. Make sure you replace the PLACEHOLDER values with your branch name, new GitHub repository name, and GitHub user name respectively. The branch name must be a valid remote branch of gitpod-laravel-starter.

__branch=PLACEHOLDER; __new_repo_project_name=PLACEHOLDER; __github_username=PLACEHOLDER; mkdir "$__new_repo_project_name" && cd "$__new_repo_project_name" && git clone https://github.com/apolopena/gitpod-laravel8-starter.git -b "$__branch" --single-branch . && rm -rf .git && git init && git add -A && git commit -m "initial commit built from the $__branch branch of  https://github.com/apolopena/gitpod-laravel8-starter" && git remote add origin "https://github.com/$__github_username/$__new_repo_project_name.git" && git branch -m main && git push -u origin main

The Dabbler

This is fast way to start and be able to make changes in your own repository but is not sufficient for building your own project or more than one project since you will be using a fork of gitpod-laravel-starter rather than a copy of your own.

1. Fork gitpod-laravel-starter
2. Create a Gitpod workspace using the url from your project fork appended to https://gitpod.io/#/
   • Your URL should look like this https://github.com/username/gitpod-laravel-starter
   • Where username is the username of your github account.
   • Put the URL in your browser and hit Enter