Skip to content

Commit 48dcb3c

Browse files
author
zetlen
committed
feat(venia): Script to lint queries against schema
1 parent 773a81c commit 48dcb3c

File tree

6 files changed

+471
-259
lines changed

6 files changed

+471
-259
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,18 @@ Follow these steps to install the dependencies for all the packages in the proje
6363
5. To run the Venia theme development experience, run `npm run watch:venia` from package root.
6464
6. To run the full PWA Studio deeloper experience, with Venia hot-reloading and concurrent Buildpack/Peregrine rebuilds, run `npm run watch:all` from package root.
6565

66+
## Troubleshooting
67+
68+
### When I run the developer mode, I get validation errors
69+
70+
Make sure you have created a `.env` file in `packages/venia-concept` which specifies variables for your local development environment. You can copy from the template `packages/venia-concept/.env.dist`.
71+
72+
### Venia queries to GraphQL produce validation errors
73+
74+
Venia and its GraphQL queries may be out of sync with the schema of your connected Magento instance. Make sure the Magento instance is up to date with the 2.3 development branch, and your copy of this repository (or your dependency on it) is up to date.
75+
76+
**To test whether your queries are up to date, run `npm run validate:venia:gql` at project root.**
77+
6678
## Things not to do
6779

6880
When using a monorepo and lerna, it's important that you break some common habits that are common when developing front-end packages.

0 commit comments

Comments
 (0)