Skip to content

Commit 884d6e4

Browse files
author
Shawn McCool
committed
Merge pull request laravelio#124 from mattstauffer/homestead-docs-nextVersionThisTimeMatt
Update readme for homestead.
2 parents 341dfb4 + 9a465ac commit 884d6e4

File tree

1 file changed

+52
-43
lines changed

1 file changed

+52
-43
lines changed

README.md

Lines changed: 52 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,76 @@
11
## Laravel.IO Community Portal
22

3-
This is the Laravel.IO community portal site. The site is entirely open source and community involvement is not only encouraged, but required in order to ensure the future success of the project.
3+
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/50a7431f-66b0-4221-8837-7ccf1924031e/mini.png)](https://insight.sensiolabs.com/projects/50a7431f-66b0-4221-8837-7ccf1924031e)
4+
5+
This is the Laravel.IO community portal site. The site is entirely open source and community involvement is not only encouraged, but necessary in order to ensure the future success of the project.
46

57
> It's important to note that the application is in heavy development right now. Please do not submit pull requests until you've submitted a proposal issue, first. We'd really hate to have people work really hard on a pull request only to find out that it won't make it into the project.
68
79
### Requirements
810

911
1. PHP 5.4
1012
2. Vagrant
11-
3. Chef
12-
4. Virtualbox
13-
5. NodeJS
14-
15-
### Recommended
16-
17-
1. Vagrant - Our entire workflow is built into a Vagrant setup. Those looking to
18-
contribute to the project should use the Vagrant configuration for a number
19-
of reasons. These include ease of configuration and ensuring that the
20-
environments used are compatible.
13+
3. Virtualbox
14+
4. NodeJS & NPM
15+
5. Ruby, Sass, and Compass
2116

2217
### Local Installation
2318

2419
Here are the steps for installation on a local machine using the officially endorsed workflow.
2520

26-
1. Install [Vagrant][1], [Chef][2], and [VirtualBox][3] from their websites. **NOT** from package managers. If you install any of these from package managers, please do not ask for help or support when things break, which will VERY likely happen. Additional information can be found here: https://github.com/ShawnMcCool/vagrant-chef
21+
1. If you haven't already, install Laravel Homestead and all of its dependencies (Vagrant, Virtualbox). The environment provided by Homestead the most consistent and predictable environment for developing on the project.
2722

28-
_Note_: If you are running OS X 10.9 Mavericks, you will need to modify the install.sh file for it to work properly. Run the following in your preferred terminal:
23+
[Laravel Homestead Installation Instructions][4]
2924

30-
```
31-
wget https://raw2.github.com/ShawnMcCool/vagrant-chef/master/chef/scripts/chef-osx.sh
32-
chmod +x chef-osx.sh
33-
sudo ./chef-osx.sh
34-
```
35-
36-
2. Add "10.10.10.10 app.local" to your HOSTS file. Instructions below for Linux.
25+
2. Add "127.0.0.1 io.local" to your HOSTS file. For *nix/Mac, either `sudo vim /etc/hosts` and add it there or run the command below:
3726
```
38-
echo "10.10.10.10 app.local" | sudo tee -a /etc/hosts
27+
echo "127.0.0.1 io.local" | sudo tee -a /etc/hosts
3928
```
40-
3. Clone down this repository
29+
3. Clone down this repository to your code/sites folder
4130
```
4231
git clone [email protected]:LaravelIO/laravel-io.git
4332
```
44-
4. Run the install vagrant script
33+
4. Add the app to Homestead by adding the following lines to your Homestead.yaml:
34+
```
35+
- map io.local
36+
to: /home/vagrant/Code/laravel.io/public
4537
```
46-
bash resources/scripts/install_vagrant.sh
38+
5. If your Homestead environment has already been provisioned, refresh it, either by running `vagrant destroy` and then `vagrant up`, or by running the following within your `vagrant ssh`:
4739
```
48-
5. SSH into the vagrant box and run the update environment script
40+
serve io.local /home/vagrant/Code/laravel.io/public
41+
```
42+
6. Create a `lio_development` MySQL database in Homestead.
4943
50-
```
51-
$ vagrant ssh
44+
7. **The remaining steps will all be from within your vagrant ssh, run from the laravel.io folder.**
45+
Chmod your storage folder
46+
```
47+
chmod -R 777 app/storage
48+
```
49+
50+
8. Composer install
51+
```
52+
composer install --no-scripts
53+
```
54+
55+
9. Migrate and seed your database
56+
```
57+
php artisan migrate --env=local
58+
php artisan db:seed --env=local
59+
```
5260
53-
$ cd /vagrant
61+
10. Optimize your autoloader
62+
```
63+
php artisan dump-autoload
64+
```
5465
55-
$ bash resource/scripts/update_environment.sh
56-
```
5766
5867
Now, we must install the oauth configuration.
5968
60-
1. [Create an application][4] in your github account called something like "Laravel IO Development" and add your GH application's client id and secret to this config file. Your GitHub Application should be set up as follows:
69+
1. [Create an application][5] in your github account called something like "Laravel IO Development" and add your GH application's client id and secret to this config file. Your GitHub Application should be set up as follows:
6170
62-
a. Full URL: http://app.local
71+
a. Full URL: http://io.local:8000
6372
64-
b. Callback URL: http://app.local/login
73+
b. Callback URL: http://io.local:8000/login
6574
2. Create the configuration file below at ***app/config/packages/artdarek/oauth-4-laravel/config.php***
6675
6776
```PHP
@@ -72,8 +81,8 @@ return [
7281
7382
'consumers' => [
7483
'GitHub' => [
75-
'client_id' => '',
76-
'client_secret' => '',
84+
'client_id' => 'YOUR_NEW_CLIENT_ID_HERE',
85+
'client_secret' => 'YOUR_NEW_CLIENT_SECRET_HERE',
7786
'scope' => ['user'],
7887
],
7988
],
@@ -82,19 +91,18 @@ return [
8291

8392
### Workflow
8493

85-
When you'd like to work on the application, run vagrant up. When you're finished, run vagrant suspend.
86-
87-
Access the application at the URL: http://app.local/ (the trailing front-slash tends to be required for .local tlds in most browsers).
94+
Before working on the application, make sure your Homestead vagrant install is up.
8895

89-
When you'd like to access the database, connect to host app.local port 3306 using the user/password root/password.
90-
91-
After pulling down changes, ssh into the vagrant box and run the update_environment.sh script.
96+
Access the application at the URL: http://io.local:8000/ (the trailing front-slash tends to be required for .local tlds in most browsers).
9297

9398
### Frontend
9499

95100
Because we keep the generated / minified css out of the repository, we must have a workflow for compiling the styles.
101+
96102
* Install the latest NodeJS
97-
* Finally, run "compass watch" in your /public folder and the minified css will be generated and also your filesystem will watch for file changes (and overwrites the .css). You can also run "compass compile" as a single one-time command to generate the css and don't watch the filesystem.
103+
* Install Ruby via RVM
104+
* Install Sass and Compass
105+
* Finally, run "compass watch" in your /public folder and the minified css will be generated and also your filesystem will watch for file changes (and overwrites the .css). You can also run "compass compile" as a single one-time command to generate the css and don't watch the filesystem.
98106

99107
### Contribution
100108

@@ -110,4 +118,5 @@ You probably don't have hardware virtualization support enabled in your computer
110118
[1]: http://downloads.vagrantup.com/
111119
[2]: http://www.opscode.com/chef/install/
112120
[3]: https://www.virtualbox.org/wiki/Downloads
113-
[4]: https://github.com/settings/applications
121+
[4]: http://laravel.com/docs/homestead
122+
[5]: https://github.com/settings/applications

0 commit comments

Comments
 (0)