super-graph/README.md

48 lines
2.1 KiB
Markdown
Raw Normal View History

2019-03-24 14:57:29 +01:00
# Super Graph
## Instant GraphQL API for Rails. Zero code.
Get an high-performance GraphQL API for your Rails app in seconds. Super Graph will auto-learn your database structure and relationships. Built in support for Rails authentication and JWT tokens.
2019-03-24 14:57:29 +01:00
2019-04-04 06:53:24 +02:00
![Super Graph Web UI](docs/.vuepress/public/super-graph-web-ui.png?raw=true "Super Graph Web UI for web developers")
2019-03-30 06:11:30 +01:00
## Why I built Super Graph?
2019-03-24 14:57:29 +01:00
I have a Rails app that gets a bit of traffic. While planning to improve the UI using React or Vue I found that my current APIs didn't have what we needed. I'd have to add more controllers and ensure they are providing the right amount of data. This required designing new APIs and making sure they match what the webdevs need. While this is all to common work I was bored and there had to be a better way.
2019-03-24 14:57:29 +01:00
All my Rails controllers were esentially wrappers around database queries and its not exactly fun writing more of them.
2019-03-24 14:57:29 +01:00
I always liked GraphQL it made everything so simple. Web devs can use GraphQL to fetch exactly the data they need. There is one small issue however you still hasve to write a lot of the same database code.
I wanted a GraphQL server that just worked the second you deployed it without having to write a line of code.
And so after a lot of coffee and some avocado toasts Super Graph was born. An instant GraphQL API service that's 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-03-24 14:57:29 +01:00
## Features
2019-04-07 07:12:11 +02:00
- Works with Rails database schemas
- Automatically learns schemas and relationships
2019-03-24 14:57:29 +01:00
- Belongs-To, One-To-Many and Many-To-Many table relationships
2019-04-07 07:12:11 +02:00
- Full text search and Aggregations
- Rails Auth supported (Redis, Memcache, Cookie)
- JWT tokens supported (Auth0, etc)
- Highly optimized and fast Postgres SQL queries
- Configure with a simple config file
- High performance GO codebase
2019-03-24 14:57:29 +01:00
- Tiny docker image and low memory requirements
2019-04-11 07:39:59 +02:00
## Documentation
[supergraph.dev](https://supergraph.dev)
2019-03-24 14:57:29 +01:00
## Contact me
[twitter.com/dosco](https://twitter.com/dosco)
## License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) 2019-present Vikram Rangnekar