Skip to content

Commit a97ac3e

Browse files
authored
Update README to include fully local run
- the instructions to run ember-api-docs and ember-api-docs-data fully locally were housed in ember-jsonapi-docs, but having them here in the actual frontend seems a bit more intuitive
1 parent 9036613 commit a97ac3e

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,29 @@ ember serve
4747
```
4848
View at http://localhost:4200
4949

50+
## Run fully-locally using `ember-api-docs-data`
51+
52+
The Prembered version of the ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so all you need to do is create a symbolic link to ember-api-docs-data and you can see the app running locally.
53+
54+
Clone all of the following repositories into the same directory so they are "siblings" on the file system
55+
56+
- This repository, `ember-api-docs`
57+
- [ember-data](https://github.com/emberjs/data/)
58+
59+
```sh
60+
git clone https://github.com/ember-learn/ember-api-docs-data
61+
cd ../ember-api-docs-data
62+
npm install
63+
cd ..
64+
git clone https://github.com/ember-learn/ember-api-docs
65+
cd ember-api-docs
66+
ln -s ../ember-api-docs-data # assuming it's checked out in the same folder
67+
npm install
68+
npm start
69+
```
70+
71+
Visit the app in your browser at [http://localhost:4200](http://localhost:4200)
72+
5073
## a11y testing
5174

5275
To run a11y tests, run `test_a11y=yes ember serve`

0 commit comments

Comments
 (0)