Docs: improve Console contributing instructions

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6471
GitOrigin-RevId: bec885589e9e8e631e73dc288dea60375d5e9248
This commit is contained in:
Luca Restagno 2022-10-25 10:13:08 +02:00 committed by hasura-bot
parent 3fee21f2a0
commit 49e9c47db3
2 changed files with 21 additions and 3 deletions

View File

@ -28,7 +28,8 @@ Feel free to open pull requests to address these issues or to add/fix console f
### Prerequisites
- [Node.js](https://nodejs.org/en/) (v12+, it is recommended that you use `node` with version `v12.x.x` A.K.A `erbium` or version `14.x.x` A.K.A `Fermium`)
- [Node.js](https://nodejs.org/en/) (v16 aka 'Gallium')
- [nvm](https://github.com/nvm-sh/nvm) (Linux and macOS, [deeper shell integration](https://github.com/nvm-sh/nvm#deeper-shell-integration) strongly suggested) or [nvm-windows](https://github.com/coreybutler/nvm-windows) (Windows)
- [Hasura GraphQL Engine](https://hasura.io/docs/latest/graphql/core/getting-started/index.html)
- [Hasura CLI](https://hasura.io/docs/latest/graphql/core/hasura-cli/install-hasura-cli.html) (for working with migrations)
@ -41,9 +42,16 @@ Feel free to open pull requests to address these issues or to add/fix console f
git clone https://github.com/<your-user-name>/graphql-engine
cd graphql-engine
cd console
npm run deps
nvm use
npm ci
npm run server-build
```
At this point you need to compile and run the graphql-engine (follow the [getting started guide](../../server//CONTRIBUTING.md)), run it, and the console will be served at `http://localhost:8080`.
Alternatively, run the Console development server as described below.
### Run console development server
Hasura console can be developed in two modes, `server` or `cli` mode. If you are looking to add/tweak functionality related to migrations, check out [Develop with Hasura CLI](#develop-with-hasura-cli-cli-mode), otherwise check out [Develop with Hasura GraphQL engine](#develop-with-hasura-graphql-engine-server-mode).
@ -95,8 +103,17 @@ IS_ADMIN_SECRET_SET=true
##### Run console development server:
Switch to the correct version of Node with [nvm](https://github.com/nvm-sh/nvm) (it's strongly suggested to activate [deeper shell integration](https://github.com/nvm-sh/nvm#deeper-shell-integration))
```bash
npm run dev
nvm install
nvm use
```
Run the development server
```bash
npm run dev
```
#### Develop with Hasura CLI (`cli` mode)

View File

@ -54,6 +54,7 @@ After making your changes
...console assets:
$ cd console
$ nvm use
$ npm ci
$ npm run server-build
$ cd ..