mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-13 19:33:55 +03:00
fix typos, punctuation, etc in docs (#635)
This commit is contained in:
parent
596bccde49
commit
d02361ce14
@ -22,7 +22,7 @@ consisting of 3 components. Each have their own contributing guides:
|
||||
3. [Console (JavaScript)](console/README.md#contributing-to-hasura-console)
|
||||
|
||||
All of the three components have a single version, denoted by either the git
|
||||
tag, or a combination of branch name and git commit SHA.
|
||||
tag or a combination of branch name and git commit SHA.
|
||||
|
||||
For all contributions, a CLA (Contributor License Agreement) needs to be signed [here](https://cla-assistant.io/hasura/graphql-engine) before (or after) the pull request has been submitted. A bot will prompt the same as a pull request comment.
|
||||
|
||||
@ -65,11 +65,11 @@ before-mentioned sections).
|
||||
#<issue-no>` in the commit message, at the end.
|
||||
For example: `resolve answers to everything (fix #42)` or `resolve answers to everything, fix #42`
|
||||
|
||||
- Rebase master with your branch before submitting pull request.
|
||||
- Rebase master with your branch before submitting a pull request.
|
||||
|
||||
## Commit messages
|
||||
|
||||
- The first line should be a summary of the changes - not execeeding 50
|
||||
- The first line should be a summary of the changes - not exceeding 50
|
||||
characters. Followed by an optional body which has more details about the
|
||||
changes. (https://github.com/erlang/otp/wiki/writing-good-commit-messages)
|
||||
|
||||
|
@ -111,7 +111,7 @@ processing - [read more](event-triggers.md).
|
||||
|
||||
## Demos
|
||||
|
||||
Checkout all the example applications in the
|
||||
Check out all the example applications in the
|
||||
[community/examples](community/examples) directory.
|
||||
|
||||
### Realtime applications
|
||||
|
@ -44,4 +44,4 @@ hasura console [flags]
|
||||
|
||||
* [hasura](hasura.md) - Hasura GraphQL Engine command line tool
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Sep-2018
|
||||
###### Auto generated by spf13/cobra on 28-Sep-2018
|
@ -34,11 +34,11 @@ cd console
|
||||
npm install
|
||||
```
|
||||
|
||||
Hasura console can be developed in two modes (`server` or `cli` mode). Both modes requires a running instance of GraphQL Enigne. The easiest way to get Hasura GraphQL engine instance is by Heroku. You can get it by following the steps given in [this](https://docs.hasura.io/1.0/graphql/manual/getting-started/heroku-simple.html) link. Other methods to install Hasura GraphQL engine is documented [here](https://docs.hasura.io/1.0/graphql/manual/getting-started/index.html).
|
||||
Hasura console can be developed in two modes (`server` or `cli` mode). Both modes require a running instance of GraphQL Enigne. The easiest way to get Hasura GraphQL engine instance is by Heroku. You can get it by following the steps given in [this](https://docs.hasura.io/1.0/graphql/manual/getting-started/heroku-simple.html) link. Other methods to install Hasura GraphQL engine is documented [here](https://docs.hasura.io/1.0/graphql/manual/getting-started/index.html).
|
||||
|
||||
### Development with Hasura GraphQL Engine (`server` mode)
|
||||
|
||||
Hasura GraphQL engine should be running to develop console in this mode. If you have set it up on heroku, your url will look like `<app-name>.herokuapp.com`, if it's on you local machine, it's probably `http://localhost:8080`.
|
||||
Hasura GraphQL engine should be running to develop console in this mode. If you have set it up on heroku, your url will look like `<app-name>.herokuapp.com`, if it's on your local machine, it's probably `http://localhost:8080`.
|
||||
|
||||
[Dotenv](https://github.com/motdotla/dotenv) is used for setting environment variables for development. Create a `.env` file in the root directory for console (wherever package.json is). Sample `.env` file will look like below
|
||||
|
||||
@ -119,7 +119,7 @@ Visit [http://localhost:3000](http://localhost:3000) to confirm the setup.
|
||||
|
||||
![Testing Development Server](../assets/console-readme-assets/test-dev-setup.jpg)
|
||||
|
||||
### Make changes to code
|
||||
### Make changes to the code
|
||||
|
||||
Make changes to the code and the console will reload automatically to reflect the new changes. Keep iterating.
|
||||
When adding a new feature, it is recommended to add corresponding tests too.
|
||||
|
@ -93,7 +93,7 @@ Transform and load data into external data-stores. Check out this demo and tutor
|
||||
|
||||
### Building reactive UX for your async backend with realtime GraphQL
|
||||
|
||||
Propagate event driven and asynchronous information to UI clients easily with GraphQL subscriptions & live-queries.
|
||||
Propagate event-driven and asynchronous information to UI clients easily with GraphQL subscriptions & live-queries.
|
||||
|
||||
![Reactive apps architecture](assets/reactive-apps-arch.png)
|
||||
|
||||
|
@ -6,7 +6,7 @@ own machine, and how to contribute.
|
||||
## Pre-requisites
|
||||
|
||||
- [stack](https://docs.haskellstack.org/en/stable/README/#how-to-install)
|
||||
- A postgres server (Recommended: Use docker to run a local postgres instance)
|
||||
- A Postgres server (Recommended: Use docker to run a local postgres instance)
|
||||
- GNU Make (optional)
|
||||
|
||||
## Development workflow
|
||||
@ -26,7 +26,7 @@ own machine, and how to contribute.
|
||||
|
||||
### Work
|
||||
- Work on the feature/fix
|
||||
- Add testcases if relevant
|
||||
- Add test cases if relevant
|
||||
|
||||
### Test
|
||||
- Run tests: `stack test --ta --database-url=<database-url>`
|
||||
|
Loading…
Reference in New Issue
Block a user