Laravel.IO Community Portal
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.
Table of Contents
Requirements
We use Laravel Homestead for local development. Please review the Homestead documentation to install it.
In order to compile stylesheets you will also need Ruby, Sass, and Compass installed.
Installation
Here are the steps for installation on a local machine.
- Make sure you have Laravel Homestead installed.
- Clone this repository:
git clone [email protected]:LaravelIO/laravel-io.git laravelio/
. - Add the path for the cloned laravel.io repository to the
Homestead.yml
file under thefolders
list. - Add a site
lio.loc
for the laravel.io repository to theHomestead.yml
file under thesites
list. - Run
vagrant provision
in your Homestead folder. - Create a database in Homestead called
laravelio
. - Run
composer install --dev
andphp artisan migrate --seed --env=local
. - Add
192.168.10.10 lio.loc
to your computer'shosts
file. - Follow the configuration steps below to configure the external services.
Configuration
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.
- Create the configuration file below at the root of your application with the name .env.local.php.
<?php
return [
'GITHUB_CLIENT_ID' => '',
'GITHUB_CLIENT_SECRET' => '',
'GOOGLE_RECAPTCHA_SITEKEY' => '',
'GOOGLE_RECAPTCHA_SECRETKEY' => '',
];
-
Create an application 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.a. Full URL: http://lio.loc b. Callback URL: http://lio.loc/login
-
Register a new website for the Google ReCaptcha service and fill in the site key and secret key in the
.env.local.php
file.
You can now visit the app in your browser by visiting http://lio.loc/.
Frontend
Because we keep the generated / minified css out of the repository, we must have a workflow for compiling the styles.
- Be sure you have Ruby, Sass, and Compass installed on your machine
- When running any compass command in the terminal, be sure to run it from your
/public
folder. - Compass is the tool used to compile Sass source files into CSS files; you can run
compass compile
to run it once, orcompass watch
to trigger a script that will watch your Sass files for changes and trigger a new compass compile on each change
Maintainer
The Laravel.IO project is currently maintained by Dries Vints. If you have any questions please don't hesitate to contact us through the support widget on the Laravel.IO website.
Contributing
Please see the contributing file for details.
License
The MIT License (MIT). Please see the license file for more information.