Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 3.56 KB

README.md

File metadata and controls

71 lines (48 loc) · 3.56 KB

Lighthouse

Continuous Integration Code Coverage PHPStan StyleCI Packagist Latest Stable Version GitHub license Get on Slack

GraphQL Server for Laravel

Lighthouse is a PHP package that allows you to serve a GraphQL endpoint from your Laravel application. It greatly reduces the boilerplate required to create a schema, it integrates well with any Laravel project, and it's highly customizable giving you full control over your data.

The documentation lives at lighthouse-php.com.

If you like reading plain markdown, you can also find the source files in the docs folder.

Get started

If you have an existing Laravel project, all you really need to get up and running is a few steps:

  1. Install via composer require nuwave/lighthouse
  2. Publish the default schema php artisan vendor:publish --provider="Nuwave\Lighthouse\LighthouseServiceProvider" --tag=schema
  3. Use something like GraphQL Playground to explore your GraphQL endpoint

Check out the docs to learn more.

Get involved

We welcome contributions of any kind.

Changelog

All notable changes to this project are documented in CHANGELOG.md.

Upgrade Guide

When upgrading between major versions of Lighthouse, consider UPGRADE.MD.

Contributing

See how you can start CONTRIBUTING.md to this project.

Security Vulnerabilities

If you discover a security vulnerability within Lighthouse, please email Benedikt Franke via [email protected] or visit https://tidelift.com/security.