You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-25Lines changed: 15 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,12 @@
7
7
8
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.
9
9
10
-
11
10
## Requirements
12
11
13
12
We use Laravel Homestead for local development. Please review [the Homestead documentation](http://laravel.com/docs/homestead) to install it.
14
13
15
14
In order to compile stylesheets you will also need Ruby, Sass, and Compass installed.
16
15
17
-
18
16
## Local Installation
19
17
20
18
Here are the steps for installation on a local machine.
@@ -36,34 +34,30 @@ Here are the steps for installation on a local machine.
36
34
37
35
You can now visit the app in your browser by visiting [http://lio.loc/](http://lio.loc).
38
36
37
+
## Service Configuration
39
38
40
-
## Github OAuth Configuration
41
-
42
-
Now, we must install the oauth configuration.
43
-
44
-
1. [Create an application](https://github.com/settings/applications) 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:
39
+
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.local.php` file.
45
40
46
-
a. Full URL: http://lio.loc
47
-
b. Callback URL: http://lio.loc/login
41
+
1. Create the configuration file below at the root of your application with the name ***.env.local.php***.
48
42
49
-
2. Create the configuration file below at ***app/config/packages/artdarek/oauth-4-laravel/config.php***
50
-
51
-
```PHP
43
+
```php
52
44
<?php
53
45
54
46
return [
55
-
'storage' => 'Session',
56
-
57
-
'consumers' => [
58
-
'GitHub' => [
59
-
'client_id' => 'YOUR_NEW_CLIENT_ID_HERE',
60
-
'client_secret' => 'YOUR_NEW_CLIENT_SECRET_HERE',
61
-
'scope' => ['user'],
62
-
],
63
-
],
47
+
'GITHUB_CLIENT_ID' => '',
48
+
'GITHUB_CLIENT_SECRET' => '',
49
+
'GOOGLE_RECAPTCHA_SITEKEY' => '',
50
+
'GOOGLE_RECAPTCHA_SECRETKEY' => '',
64
51
];
52
+
65
53
```
66
54
55
+
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.local.php` file. Your GitHub application should be set up as follows.
56
+
57
+
a. Full URL: http://lio.loc
58
+
b. Callback URL: http://lio.loc/login
59
+
60
+
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.local.php` file.
67
61
68
62
## Frontend
69
63
@@ -73,24 +67,20 @@ Because we keep the generated / minified css out of the repository, we must have
73
67
- When running any compass command in the terminal, be sure to run it from your `/public` folder.
74
68
- Compass is the tool used to compile Sass source files into CSS files; you can run `compass compile` to run it once, or `compass watch` to trigger a script that will watch your Sass files for changes and trigger a new compass compile on each change
75
69
76
-
77
70
## Maintainer
78
71
79
72
The Laravel.IO project is currently maintained by [Dries Vints](https://github.com/driesvints). If you have any questions please don't hesitate to ask them in an issue or email me at [[email protected]](mailto:[email protected]).
80
73
81
-
82
74
## Testing
83
75
84
76
All tests can be run with the following command. Make sure to run this inside the Homestead box.
85
77
86
78
$ vendor/bin/phpunit
87
79
88
-
89
80
## Contributing
90
81
91
82
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
92
83
93
-
94
84
## License
95
85
96
86
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
0 commit comments