mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-11 10:46:25 +03:00
update readme and code of conduct (#108)
This commit is contained in:
Shahidh K Muhammed
GitHub
parent
3a085da736
commit
58db3b7ba9
77
README.md
77
README.md
@ -1,14 +1,75 @@
|
||||
# Hasura GraphQL Engine
|
||||
|
||||
[](https://circleci.com/gh/hasura/graphql-engine)
|
||||
[](https://docs.hasura.io)
|
||||
[](https://github.com/hasura/graphql-engine/releases)
|
||||
[](https://circleci.com/gh/hasura/graphql-engine)
|
||||
[](https://hub.docker.com/r/hasura/graphql-engine/)
|
||||
|
||||
|
||||
Source code for Hasura's GraphQL Engine, including CLI, API Console and Server.
|
||||
[](https://discord.gg/AnmPAz3)
|
||||
[](https://twitter.com/intent/follow?screen_name=HasuraHQ)
|
||||
|
||||
## Getting started
|
||||
|
||||
|
||||
[](https://heroku.com/deploy?template=https://github.com/hasura/graphql-engine-heroku)
|
||||
Hasura GraphQL Engine is a performant GraphQL server that provides **ready-to-use GraphQL API over Postgres** by auto-generating GraphQL schema and corresponding resolvers.
|
||||
|
||||
Follow the [official docs](https://docs.hasura.io/1.0/graphql/manual/getting-started/index.html).
|
||||
* **Make powerful queries**: built-in filtering, pagination, and pattern search arguments and operators
|
||||
* **Works with existing database**: point it to an existing, living Postgres database to get instant GraphQL API
|
||||
* **Fine-grained access control**: dynamic access control that
|
||||
integrates with your auth
|
||||
* **Light-weight & performant**: 20MB docker image; ~60MB RAM @ 1000 req/s; multi-core aware
|
||||
* **Dev friendly**: admin UI & Rails-inspired schema migrations
|
||||
* **Postgres** ❤️: supports Postgres types (PostGIS/geo-location, etc.), turns views to *graphs*, trigger stored functions or procedures with
|
||||
mutations
|
||||
|
||||
## Quickstart - Setup on Heroku
|
||||
|
||||
:information_source: *no credit-card required*; sign-up may be required
|
||||
|
||||
1. Click on the following button to deploy GraphQL Engine on Heroku and provision the free Postgres add-on:
|
||||
|
||||
[](https://heroku.com/deploy?template=https://github.com/hasura/graphql-engine-heroku)
|
||||
|
||||
2. Open the admin console
|
||||
|
||||
Visit https://\<app-name\>.herokuapp.com (*replace \<app-name\> with your app name*) to open the admin console.
|
||||
|
||||
3. Make your first GraphQL query
|
||||
|
||||
Create test tables and instantly run your first query. Follow this [simple guide](https://docs.hasura.io/1.0/graphql/manual/getting-started/first-graphql-query.html).
|
||||
|
||||
### Other deployment methods
|
||||
|
||||
For Docker-based deployment and advanced configuration options, see deployment guides [here](https://docs.hasura.io/1.0/graphql/manual/getting-started/index.html).
|
||||
|
||||
## Architecture
|
||||
|
||||
The Hasura GraphQL Engine fronts a Postgres database instance and can serve as an API Gateway for all data requests from client apps. It can be configured to work with your existing Auth middleware to handle access control to data using field-level rules with dynamic variables.
|
||||
|
||||
The GraphQL Engine is a standalone, multi-core aware component that can be scaled vertically and horizontally.
|
||||
|
||||
|
||||
|
||||
You can also place the engine behind a central GraphQL proxy that fronts multiple GraphQL APIs via schema stitching.
|
||||
|
||||
|
||||
|
||||
## Client-side tooling
|
||||
|
||||
GraphQL Engine provides an HTTP API. This means you can use any client-side tool or library to query the endpoint. To fully leverage GraphQL, it is recommended that you use GraphQL specific client-side tooling like [Apollo Client](https://github.com/apollographql/apollo-client), [Relay](https://github.com/facebook/relay), etc. See [awesome-graphql](https://github.com/chentsulin/awesome-graphql) for a list of such tools.
|
||||
|
||||
## Community
|
||||
|
||||
GraphQL Engine has a burgeoning community of amazing developers! Come join the community using your preferred means of communication:
|
||||
|
||||
- [Discord](https://discord.gg/vBPpJkS)
|
||||
- [Intercom chat](https://hasura.io/help)
|
||||
- [Twitter](https://twitter.com/hasurahq)
|
||||
- [Email](mailto:build@hasura.io)
|
||||
- [Facebook](https://www.facebook.com/HasuraHQ/)
|
||||
- [Docs](https://docs.hasura.io)
|
||||
|
||||
We are committed to fostering an open and welcoming environment in the community. Please see the [Code of Conduct](code-of-conduct.md) (*adapted from the [Contributor Covenant](https://www.contributor-covenant.org])*).
|
||||
|
||||
## Contributing
|
||||
|
||||
@ -16,8 +77,6 @@ Checkout our [contributing guide](CONTRIBUTING.md) for more details.
|
||||
|
||||
## License
|
||||
|
||||
GraphQL Engine is available under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html) (AGPL-3.0). [Why AGPL](https://gist.github.com/hasura-bot/9c36a0201a7563f7762b265a12b044d5).
|
||||
|
||||
:information_source: If you are not satisfied with this license, commercial licenses are available on request. Please feel free to contact us at build@hasura.io or [hasura.io/help](https://hasura.io/help).
|
||||
|
||||
GraphQL Engine is available under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html) (AGPL-3.0). [Why AGPL?](https://gist.github.com/hasura-bot/9c36a0201a7563f7762b265a12b044d5).
|
||||
|
||||
:information_source: Commercial licenses are available on request. Please feel free to contact us at build@hasura.io or [hasura.io/help](https://hasura.io/help).
|
||||
BIN
assets/banner.png
Normal file
BIN
assets/banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
73
code-of-conduct.md
Normal file
73
code-of-conduct.md
Normal file
@ -0,0 +1,73 @@
|
||||
# Hasura GraphQL Engine Community Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, nationality, personal
|
||||
appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at build@hasura.io. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
Loading…
Reference in New Issue
Block a user