Skip to content

Commit f47c111

Browse files
authored
fix(data): update README to include correct Node version; add instructions for generating models locally (#283) (#432)
1 parent f3344a3 commit f47c111

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Readme.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,19 @@ Amplify Codegen is a JavaScript toolkit library for frontend and mobile develope
2727
| graphql-types-generator | Generates type annotations from GraphQL schema and statements |
2828
## Developing
2929

30-
This section should get you running with **Amplify Codegen**. You will need the latest version of [nodejs](https://nodejs.org/en/) on your system and developing locally also requires `yarn` workspaces. You can install it [here](https://classic.yarnpkg.com/en/docs/install#mac-stable).
30+
This section should get you running with **Amplify Codegen**. You will need to set [nodejs](https://nodejs.org/en/) to a version less than v16 on your system. Developing locally also requires [yarn](https://classic.yarnpkg.com/en/docs/install#mac-stable).
3131

32-
Start by, [Forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-codegen](https://github.com/aws-amplify/amplify-codegen).
32+
Start by [Forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-codegen](https://github.com/aws-amplify/amplify-codegen).
3333

3434
```
3535
$ git clone [email protected]:[username]/amplify-codegen.git
3636
$ cd amplify-codegen
3737
3838
$ yarn setup-dev
3939
```
40+
41+
To generate model files in an Amplify app using the local version of codegen, run `amplify-dev codegen models` in an Amplify app.
42+
4043
Before pushing code or sending a pull request, do the following:
4144

4245
- At the command line, run `npm run lint` at the top-level directory. This invokes lerna to check for lint errors in all of our packages.

0 commit comments

Comments
 (0)