README.md
<p align="center">
<a href="https://railt.org"><img src="https://railt.org/images/logo-dark.svg" width="200" alt="Railt" /></a>
</p>
<p align="center">
<a href="https://travis-ci.org/railt/railt"><img src="https://travis-ci.org/railt/railt.svg?branch=1.4.x" alt="Travis CI" /></a>
<a href="https://codeclimate.com/github/railt/railt/test_coverage"><img src="https://api.codeclimate.com/v1/badges/07b06e5fc97ecbfaafb6/test_coverage" /></a>
<a href="https://codeclimate.com/github/railt/railt/maintainability"><img src="https://api.codeclimate.com/v1/badges/07b06e5fc97ecbfaafb6/maintainability" /></a>
</p>
<p align="center">
<a href="https://packagist.org/packages/railt/railt"><img src="https://img.shields.io/badge/PHP-7.1+-6f4ca5.svg" alt="PHP 7.1+"></a>
<a href="https://railt.org"><img src="https://img.shields.io/badge/official-site-6f4ca5.svg" alt="railt.org"></a>
<a href="https://discord.gg/ND7SpD4"><img src="https://img.shields.io/badge/discord-chat-6f4ca5.svg" alt="Discord"></a>
<a href="https://packagist.org/packages/railt/railt"><img src="https://poser.pugx.org/railt/railt/version" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/railt/railt"><img src="https://poser.pugx.org/railt/railt/downloads" alt="Total Downloads"></a>
<a href="https://raw.githubusercontent.com/railt/railt/1.4.x/LICENSE.md"><img src="https://poser.pugx.org/railt/railt/license" alt="License MIT"></a>
</p>
## Introduction
Project idea is clean and high-quality code.
Unlike most (all at the moment) implementations, like [webonyx](https://github.com/webonyx/graphql-php),
[youshido](https://github.com/youshido-php/GraphQL) or [digitalonline](https://github.com/digiaonline/graphql-php)
the Railt contains a completely own implementation of the GraphQL SDL parser
which is based on [EBNF-like grammar](https://github.com/railt/railt/tree/1.4.x/resources/graphql). This opportunity
allows not only to have the [original implementation of the language](https://facebook.github.io/graphql/draft/) and to
keep it always up to date, but also to implement [a new backward compatible
functionality](https://github.com/railt/railt/projects/1) that is not available
to other implementations.
Goal of Railt:
- Do not repeat the mistakes made in the JS-based implementations.
- Implement a modern and convenient environment for PHP developers.
- Implement easy integration into any ready-made solutions based on PSR.
- Provide familiar functionality (including dependency injection, routing, etc.).
## Installation
Via [Composer](https://getcomposer.org/):
- Add into your `composer.json`:
```json
{
"scripts": {
"post-autoload-dump": [
"Railt\\Discovery\\Manifest::discover"
]
}
}
```
- `composer require railt/railt`
## Quick Start
Let's create our first GraphQL schema!
```graphql
schema {
query: Example
}
type Example {
say(message: String = "Hello"): String!
@route(action: "ExampleController@say")
}
```
In order to return the correct answer from the `say` field let's create an
`ExampleController` controller with the desired method `say`.
```php
class ExampleController
{
public function say(string $message): string
{
return $message;
}
}
```
That's all we need to know 🚀
But I think we should still run the application. For the [Symfony](https://github.com/railt/symfony-bundle)
and [Laravel](https://github.com/railt/laravel-provider) there are appropriate
packages, but if you do not use (or do not want to use) frameworks, it is not
difficult to do it from scratch.
The `index.php` is the main file that handles all requests to the application.
So let's create it and write a simple logic:
```php
<?php
use Phplrt\Io\File;
use Railt\Http\Factory;
use Railt\Foundation\Application;
use Railt\Http\Provider\GlobalsProvider;
require __DIR__ . '/vendor/autoload.php';
// Creating a new Application in debug mode information
// about which is passed in the first argument.
$app = new Application(true);
// Create a connection
$connection = $app->connect(File::fromPathname(__DIR__ . '/schema.graphqls'));
// Processing of HTTP Request
$responses = $connection->request(Factory::create(new GlobalsProvider()));
// And send the HTTP Response
$responses->send();
```
...send request
```graphql
{
say(message: "Something is awesome!")
}
```
...and get the answer!
```json
{
"say": "Something is awesome!"
}
```
That's how simple it is 🎈
## Learning Railt
> This documentation can contain NOT RELEVANT information and currently in progress.
- [English](https://en.railt.org)
- [Russian](https://ru.railt.org)
## Contributing
Thank you for considering contributing to the Railt Framework!
The contribution guide can be found in the [documentation](https://railt.org/docs/contributions).
## Security Vulnerabilities
If you discover a security vulnerability within Railt, please send an e-mail to maintainer
at nesk@xakep.ru. All security vulnerabilities will be promptly addressed.
## License
The Railt Framework is open-sourced software licensed under
the [MIT license](https://opensource.org/licenses/MIT).
## Help & Community [](https://discord.gg/ND7SpD4)
Join our [Discord community](https://discord.gg/ND7SpD4) if you run into issues or have questions. We love talking to you!
<p align="center"><a href="https://discord.gg/ND7SpD4"><img src="https://habrastorage.org/webt/mh/s4/hg/mhs4hg2eb0roaix7igak0syhcew.png" /></a></p>
## Supported By
<p align="center">
<a href="https://www.jetbrains.com/?from=Railt" target="_blank"><img src="https://habrastorage.org/webt/oc/-2/ek/oc-2eklcyr_ncszrzytmlu8_vky.png" alt="JetBrains" /></a>
<a href="https://rambler-co.ru/" target="_blank"><img src="https://habrastorage.org/webt/wp/wu/wp/wpwuwpqpkskjfs0yjdjry5jvoog.png" alt="Rambler&Co" /></a>
</p>