super-graph/docs/README.md

73 lines
2.7 KiB
Markdown
Raw Normal View History

2019-04-04 06:52:52 +02:00
---
home: true
2019-04-18 15:27:36 +02:00
heroImage: /logo.svg
2019-04-04 06:52:52 +02:00
heroText: "SUPER GRAPH"
tagline: Get an instant GraphQL API for your Rails apps.
actionText: Get Started →
actionLink: /guide
features:
- title: Simple
details: Easy config file, quick to deploy, No code needed. It just works.
- title: High Performance
details: Converts your GraphQL query into a fast SQL one.
- title: Written in GO
details: Go is a language created at Google to build secure and fast web services.
footer: MIT Licensed | Copyright © 2018-present Vikram Rangnekar
---
![Super Graph Web UI](/super-graph-web-ui.png "Super Graph Web UI for web developers")
Without writing a line of code get an instant high-performance GraphQL API for your Ruby-on-Rails app. Super Graph will automatically understand your apps database and expose a secure, fast and complete GraphQL API for it. Built in support for Rails authentication and JWT tokens.
## Try it out
```bash
2019-04-11 07:39:59 +02:00
# download super graph source
git clone https://github.com/dosco/super-graph.git
2019-04-04 06:52:52 +02:00
2019-04-11 07:39:59 +02:00
# setup the demo rails app & database
./demo setup
2019-04-04 06:52:52 +02:00
2019-04-11 07:39:59 +02:00
# run the demo
./demo run
# signin to the demo app (user1@demo.com / 123456)
open http://localhost:3000
2019-04-04 06:52:52 +02:00
2019-04-11 07:39:59 +02:00
# try the super graph web ui
open http://localhost:8080
2019-04-04 06:52:52 +02:00
```
2019-04-13 15:12:41 +02:00
::: warning DEMO REQUIREMENTS
This demo requires `docker` you can either install it using `brew` or from the
docker website [https://docs.docker.com/docker-for-mac/install/](https://docs.docker.com/docker-for-mac/install/)
:::
## Try out GraphQL
2019-04-04 06:52:52 +02:00
```graphql
query {
users {
id
email
picture : avatar
products(limit: 2, where: { price: { gt: 10 } }) {
id
name
description
}
}
}
```
## Why I built Super Graph?
Honestly, cause it was more fun than my real work. After working on several product though my career I found myself hating building CRUD APIs (Create, Update, Delete, List, Show). It was always the same thing figure out what the UI needs then build an endpoint for it, if related data is needed than join with another table. I didn't want to write that code anymore I wanted the computer to just do it.
2019-04-04 06:52:52 +02:00
I always liked GraphQL it sounded friendly, but it still required me to write all the same database query code. Sure the API was nicer but it took a lot of work sometime even more than a simple REST API would have. I wanted a GraphQL server that just worked the second you deployed it without having to write a line of code.
2019-04-04 06:52:52 +02:00
And so after a lot of coffee and some Avocado toasts __Super Graph was born, a GraphQL server that just works, is high performance and easy to deploy__. I hope you find it as useful as I do and there's a lot more coming so hit that :star: to stay in the loop.
2019-04-04 06:52:52 +02:00
## Say hello
[twitter.com/dosco](https://twitter.com/dosco)