Skip to content

Commit 43dae75

Browse files
committed
Update readme
1 parent 70acf9d commit 43dae75

File tree

1 file changed

+17
-26
lines changed

1 file changed

+17
-26
lines changed

readme.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img src='https://coveralls.io/repos/LaravelIO/laravel.io/badge.png?branch=master' alt='Coverage Status' />
66
<img src="https://insight.sensiolabs.com/projects/50a7431f-66b0-4221-8837-7ccf1924031e/mini.png" alt="SensioLabsInsight">
77

8-
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.
8+
This is the repository for the [Laravel.io](http://laravel.io) community portal. The code is entirely open source and licensed under [the MIT license](license.txt). Feel free to contribute to the portal by sending in a pull request.
99

1010
## Table of Contents
1111

@@ -26,37 +26,28 @@ In order to compile stylesheets you will also need Ruby, Sass, and Compass insta
2626

2727
## Installation
2828

29-
Here are the steps for installation on a local machine.
30-
31-
1. Make sure you have [Laravel Homestead](http://laravel.com/docs/homestead) installed
32-
2. Clone this repository: `git clone git@github.com:LaravelIO/laravel-io.git laravelio/`
33-
3. Add the path for the cloned laravel.io repository to the `Homestead.yml` file under the `folders` list
34-
4. Add a site `lio.loc` for the laravel.io repository to the `Homestead.yml` file under the `sites` list
35-
5. Run `vagrant provision` in your Homestead folder
36-
6. Create a database in Homestead called `laravelio`
37-
7. Run `composer install` and `php artisan migrate --seed --env=local`
38-
8. Add `192.168.10.10 lio.loc` to your computer's `hosts` file
39-
9. Follow the configuration steps below to configure the external services
29+
1. Clone this repository: `git clone git@github.com:laravelio/laravel-io.git laravelio/`
30+
2. Update your `Homestead.yml` with the following settings:
31+
1. Add the path for the cloned laravel.io repository to the `folders` list
32+
2. Add a site `lio.loc` for the laravel.io repository to the `sites` list
33+
3. Add a database called `laravelio` to the `databases` list
34+
4. Run `homestead provision`
35+
3. SSH into your Homestead box and run the following commands:
36+
1. `composer install`
37+
2. `php artisan migrate --seed --env=local`
38+
4. Add `192.168.10.10 lio.loc` to your computer's `hosts` file
39+
5. Follow the configuration steps below to configure the external services
4040

4141
## Configuration
4242

43-
Laravel.io relies on some key services to function, namely Github OAuth authentication and the Google ReCaptcha service. Follow the steps below to fill in the credentials in a custom `.env` file.
44-
45-
1. Create the configuration file below at the root of your application with the name ***.env***.
46-
47-
```
48-
GITHUB_CLIENT_ID=
49-
GITHUB_CLIENT_SECRET=
50-
GOOGLE_RECAPTCHA_SITEKEY=
51-
GOOGLE_RECAPTCHA_SECRETKEY=
52-
```
43+
Laravel.io relies on some key services to function, namely Github OAuth authentication and the Google ReCaptcha service. Follow the steps below to fill in the credentials in your custom `.env` file.
5344

54-
2. [Create an application](https://github.com/settings/applications) in your github account called something like "Laravel.io Development" and add your Github application's client id and secret to the `.env` file. Your GitHub application should be set up as follows.
45+
1. [Create an application](https://github.com/settings/applications) in your github account called something like "Laravel.io Development" and add your Github application's client id, secret and url to the `.env` file. Your GitHub application should be set up as follows.
5546

5647
a. Full URL: http://lio.loc
57-
b. Callback URL: http://lio.loc/login
48+
b. Callback URL: http://lio.loc/auth/github
5849

59-
3. [Register a new website](https://www.google.com/recaptcha/admin) for the Google ReCaptcha service and fill in the site key and secret key in the `.env` file.
50+
2. [Register a new website](https://www.google.com/recaptcha/admin) for the Google ReCaptcha service and fill in the site key and secret key in the `.env` file.
6051

6152
You can now visit the app in your browser by visiting [http://lio.loc/](http://lio.loc).
6253

@@ -78,7 +69,7 @@ Please see [the contributing guide](contributing.md) for details.
7869

7970
## Security Vulnerabilities
8071

81-
If you discover a security vulnerability within Laravel.io, please send an email immediately to Dries Vints at dries.vints@gmail.com. **Do not create an issue for the vulnerability.**
72+
If you discover a security vulnerability within Laravel.io, please send an email immediately to Dries Vints at [dries.vints@gmail.com](mailto:dries.vints@gmail.com). **Do not create an issue for the vulnerability.**
8273

8374
## License
8475

0 commit comments

Comments
 (0)