Skip to content

Commit

Permalink
docs: correct dotenv dep to dotenv-flow (#646)
Browse files Browse the repository at this point in the history
* docs: correct `dotenv` dep to `dotenv-flow`

* docs: replace rest of `dotenv` -> `dotenv-flow`
  • Loading branch information
blakewilson authored Nov 17, 2021
1 parent 2fe73fe commit 40faf7b
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
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

0 comments on commit 40faf7b

Please sign in to comment.