This is the repository for the Laravel.io community portal. The code is entirely open source and licensed under the MIT license. Feel free to contribute to the portal by sending in a pull request.
- Requirements
- Installation
- Configuration
- Frontend
- Maintainers
- Contributing
- Security Vulnerabilities
- License
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.
- Clone this repository:
git clone [email protected]:laravelio/laravel-io.git laravelio/
- Update your
Homestead.yml
with the following settings:- Add the path for the cloned laravel.io repository to the
folders
list - Add a site
lio.loc
for the laravel.io repository to thesites
list - Add a database called
laravelio
to thedatabases
list - Run
homestead provision
- Add the path for the cloned laravel.io repository to the
- SSH into your Homestead box and run the following commands:
composer install
php 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
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.
-
Create an application 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.Full URL: http://lio.loc
Callback URL: http://lio.loc/auth/github -
Register a new website for the Google ReCaptcha service and fill in the site key and secret key in the
.env
file.
You can now visit the app in your browser by visiting http://lio.loc/.
Because we keep the generated / minified css out of the repository, we must have a workflow for compiling the styles.
- To compile stylesheets, we'll need Compass. Install Compass by running
sudo apt-get install ruby-compass
when ssh'd into your Homestead box. - 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
The Laravel.io portal 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.
Please see the contributing guide for details.
If you discover a security vulnerability within Laravel.io, please send an email immediately to Dries Vints at [email protected]. Do not create an issue for the vulnerability.
The MIT License. Please see the license file for more information.