Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct dotenv dep to dotenv-flow #646

Merged
merged 2 commits into from
Nov 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/next/guides/fetching-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Faust.js uses [GQty](https://gqty.dev/docs/react/fetching-data) as the primary w

GQty works primarily based on TypeScript typings generated using introspection on your GraphQL API. Using WPGraphQL as your Headless WordPress API, you can enable introspection and then generate typings for GQty. You will need to do the following:

1. Run `npm install -D @gqty/cli dotenv`
1. Run `npm install -D @gqty/cli dotenv-flow`
1. Create a `generate` script in your `package.json` that runs `gqty generate`.
1. Create a `gqty.config.js` file at the root of your project. Use the following example config:

```js
require('dotenv').config();
require('dotenv-flow').config();

/**
* @type {import("@gqty/cli").GQtyConfig}
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ module.exports = withFaust({
In the root of your project, alongside `package.json`, replace the `gqty.config.js` file with the following:

```js
require('dotenv').config();
require('dotenv-flow').config();

/**
* @type {import("@gqty/cli").GQtyConfig}
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/setup-faustjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ npm install --save-prod @faustjs/core @faustjs/next
#### Dev Dependencies

```bash
npm install --save-dev @gqty/cli dotenv
npm install --save-dev @gqty/cli dotenv-flow
```

### Create `faust.config.js`
Expand Down Expand Up @@ -105,7 +105,7 @@ Replace the `NEXT_PUBLIC_WORDPRESS_URL` value with the URL of your WordPress sit
We use [GQty](https://gqty.dev) as our GraphQL client. To configure GQty, we need to create a `gqty.config.js` file in the root of our project.

```js title=gqty.config.js
require('dotenv').config();
require('dotenv-flow').config();

/**
* @type {import("@gqty/cli").GQtyConfig}
Expand Down Expand Up @@ -186,7 +186,7 @@ Next, add the following `generate` script to your `package.json`:
"devDependencies": {
"@gqty/cli": "^1.0.4",
"@types/react": "^17.0.15",
"dotenv": "^10.0.0",
"dotenv-flow": "^3.2.0",
"typescript": "^4.3.5"
}
}
Expand Down