Skip to content

fix: update installation instructions #20

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: update installation instructions #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
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]().