Larawin

CLI to create a Laravel new project installation in your Windows + Homestead Virtual Machine environment.

Sister project to laravel-homestead-windows-installer

Makes everything easier!

TOC

• Requirements
• Installation
• Configuration
• Usage
• Features
• Command Line Arguments
• IMPORTANT - READ THIS!
• Contributing
• License

Requirements

• Git Bash for Windows
• Laravel Homestead as a VM

Installation

npm install -g larawin

Configuration

Create the configuration file:

 touch ~/.larawin.json

Copy and paste the configuration below. You may change them to suit your needs.

{
  "projectName": "",
  "vagrantFilePath": "~/Homestead",
  "homesteadFilePath": "~/Homestead",
  "installDir": "",
  "sharedFolder": "~/Code",
  "ip": "192.168.10.10"
}

Example:

 {
   "projectName": "",
   "vagrantFilePath": "D:/Homestead",
   "homesteadFilePath": "~/Homestead",
   "installDir": "Projects",
   "sharedFolder": "D:/Code",
   "ip": "192.168.10.10"
 }

In this example, all new projects will be created under D:/Code/Projects and the Vagrantfile to start and provision the server is in D:/Homestead

Usage

Open Git Bash and type: (Git Bash for Windows. This won't work in the command prompt.)

larawin projectName

Features

• Download and install Laravel in its latest version
• Edit your local Homestead.yaml file to add projectName.app to sites map and projectName.substr(0,8) as database name
• Edit your remote .env file and set DB_DATABASE=projectName.substr(0,8)

Command Line Arguments

--version|-v

• Show current version

--help|-h

• Display help text

IMPORTANT!

This script opens and writes the windows hosts file, which is a protected file. You MUST run Node JS (npm) and Git Bash for Windows in administrator mode.

Contributing

• Fork this project
• Create a new branch git checkout -b branch-name
• Make your modifications
• Test it -- run npm i -g from the root folder and test it
• Send the pull request
  • If possible, please provide thorough information on what as done
  • If I merge your pull request, your name and email will be added as a contributor

License

MIT

Copyright (c) 2017 Bruno Vaula Werneck

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.