Skip to content
main
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Tests Code Style Laravel Version

Laravel.io

This is the repository for the Laravel.io community portal. The code is entirely open source and licensed under the MIT license. We welcome your contributions but we encourage you to read the the contributing guide before creating an issue or sending in a pull request. Read the installation guide below to get started with setting up the app on your machine.

Sponsors

We'd like to thank these amazing companies for sponsoring us. If you are interested in becoming a sponsor, please visit the Laravel.io Github Sponsors page.

Requirements

The following tools are required in order to start the installation.

Installation

Note that you're free to adjust the ~/Sites/laravel.io location to any directory you want on your machine. In doing so, be sure to run the valet link command inside the desired directory.

  1. Clone this repository with git clone git@github.com:laravelio/laravel.io.git ~/Sites/laravel.io
  2. Run composer install to install the PHP dependencies
  3. Setup a local database called laravelio
  4. Run composer setup to setup the application
  5. Setup a working e-mail driver like Mailtrap
  6. (optional) Set up Github authentication (see below)

You can now visit the app in your browser by visiting http://laravel.io.test. If you seeded the database you can login into a test account with johndoe & password.

Github Authentication (optional)

To get Github authentication to work locally, you'll need to register a new OAuth application on Github. Use http://laravel.io.test for the homepage url and http://laravel.io.test/auth/github for the callback url. When you've created the app, fill in the ID and secret in your .env file in the env variables below. You should now be able to authentication with Github.

GITHUB_ID=
GITHUB_SECRET=
GITHUB_URL=http://laravel.io.test/auth/github

Algolia search (optional)

To get Algolia search running locally, you'll need to register for a new account and create an index called threads. Algolia has a free tier which satisfies all of the requirements needed for a development environment. Now update the below variables in your .env file. The App ID and secret keys can be found in the API Keys section of the Algoila UI.

SCOUT_DRIVER=algolia
SCOUT_QUEUE=true

ALGOLIA_APP_ID=
ALGOLIA_SECRET="Use the Write API Key"

MIX_ALGOLIA_APP_ID="${ALGOLIA_APP_ID}"
MIX_ALGOLIA_SECRET="Use the Search API Key"
MIX_ALGOLIA_INDEX=threads

In order to index your existing threads, run the following command:

php artisan scout:import App\\Models\\Thread

New threads will be automatically added to the index and threads which get edited will be automatically updated. If you need to flush your index and start again, you can run the following command:

php artisan scout:flush App\\Models\\Thread

Maintainers

The Laravel.io portal is currently maintained by Dries Vints and Joe Dixon. If you have any questions please don't hesitate to create an issue on this repo.

Contributing

Please read the contributing guide before creating an issue or sending in a pull request.

Code of Conduct

Please read our Code of Conduct before contributing or engaging in discussions.

Security Vulnerabilities

If you discover a security vulnerability within Laravel.io, please send an email immediately to security@laravel.io. Do not create an issue for the vulnerability.

License

The MIT License. Please see the license file for more information.

You can’t perform that action at this time.