Skip to content

Commit

Permalink
fix: update installation instructions
Browse files Browse the repository at this point in the history
- the old install instructions didn't mention the need for the data repo to be located within the ember-api-docs repo
- they also switched the serve commands
  • Loading branch information
jaredgalanis authored Nov 2, 2023
1 parent 92057e0 commit f2e73b5
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@ https://github.com/ember-learn/ember-jsonapi-docs
## Previewing these docs in the front end

If you want to see how these docs will look in the
front end app:
front end app, clone `ember-api-docs` and then clone `ember-api-docs-data` into the `ember-api-docs` directory as that is where `ember-api-docs` will search for the JSON files:

```
git clone https://github.com/ember-learn/ember-api-docs
cd ember-api-docs
npm install
npm run start:local
git clone https://github.com/ember-learn/ember-api-docs-data
cd ember-api-docs-data
yarn install
yarn serve
cd ..
git clone https://github.com/ember-learn/ember-api-docs
cd ember-api-docs-data
yarn install
yarn start:local
```

The JSON files will be served at `http://localhost:5050` and the app can be viewed in the browser at [http://localhost:4200]().

0 comments on commit f2e73b5

Please sign in to comment.