---
agentTools:
  projectIndex: https://laravel-angular.readme.io/llms.txt
---

# Install

Installation steps for Laravel Angular Material Starter

[block:api-header]
{
  "title": "2017 Update"
}
[/block]

While this starter used to be an excellent starting point for Laravel 5 & Angular 1.x, using Angular 1.x results in large JavaScript bundles which makes mobile experience slow.
Thus it's recommended to upgrade to Angular (2+).

**Checkout the new Laravel & Angular package at [laravel-angular.io](https://laravel-angular.io/)**

[block:api-header]
{
  "type": "basic",
  "title": "Which version should you use: 3.4 or 3.2?"
}
[/block]

If you're looking to build a [Progressive Web App](https://developers.google.com/web/progressive-web-apps/), version 3.4.x is recommended.
However, if you're not planning to build a Progressive Web App, then it's recommended that you stick to [version 3.2.x](http://laravel-angular.readme.io/v3.2/docs/).

[block:callout]
{
  "type": "info",
  "title": "Scroll down for beginner friendly installation"
}
[/block]

[block:code]
{
  "codes": [
    {
      "code": "composer create-project jadjoubran/laravel5-angular-material-starter --prefer-dist\ncd laravel5-angular-material-starter\nnpm install -g gulp bower\nnpm install\nbower install\n#fix database credentials in .env\nphp artisan migrate\ngulp",
      "language": "text",
      "name": "Command Line"
    }
  ]
}
[/block]

[block:callout]
{
  "type": "info",
  "body": "`gulp && gulp watch`",
  "title": "Watching assets"
}
[/block]

[block:callout]
{
  "type": "info",
  "body": "`php artisan serve` and browse to [localhost:8000](http://localhost:8000)",
  "title": "View website"
}
[/block]

[block:api-header]
{
  "type": "basic",
  "title": "Beginner friendly installation"
}
[/block]

## Requirements

Make sure you have **node** >= 4 and **npm** >= 3 by running `node -v` and `npm -v`.

Check if **gulp** is installed globally on your system by running `gulp -v`. If it's not installed, run `npm install -g gulp`.
Check if **bower** is installed globally on your system by running `bower -v`. If it's not installed, run `npm install -g bower`.

## Setup

Create the project using composer create-project command
`composer create-project jadjoubran/laravel5-angular-material-starter --prefer-dist`

then `cd` into the newly created directory

```
cd laravel5-angular-material-starter
```

and install local **node dependencies** and **bower packages**
`npm install`
`bower install`

edit your `.env` file and fix your database credentials
and then run the migrations
`php artisan migrate`

and **compile** the assets and **watch** for changes
`gulp && gulp watch`

now you need to open a new terminal tab/window and cd into the same directory in order to **serve** the application
`php artisan serve`

Your starter project is now ready on [localhost:8000](http://localhost:8000)

[block:callout]
{
  "type": "warning",
  "title": "Vagrant on Windows?",
  "body": "There are known issues if you're planning to use Vagrant on Windows, mainly with `npm`. These [issues](https://github.com/jadjoubran/laravel5-angular-material-starter/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Aenvironment%3Avagrant+) might help"
}
[/block]