From a97ac3ebefbb457d0f7e350d76ac31ab441ad43b Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 17:27:54 -0500 Subject: [PATCH] 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 --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index a006f530..cee58789 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,29 @@ ember serve ``` View at http://localhost:4200 +## Run fully-locally using `ember-api-docs-data` + +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. + +Clone all of the following repositories into the same directory so they are "siblings" on the file system + +- This repository, `ember-api-docs` +- [ember-data](https://github.com/emberjs/data/) + +```sh +git clone https://github.com/ember-learn/ember-api-docs-data +cd ../ember-api-docs-data +npm install +cd .. +git clone https://github.com/ember-learn/ember-api-docs +cd ember-api-docs +ln -s ../ember-api-docs-data # assuming it's checked out in the same folder +npm install +npm start +``` + +Visit the app in your browser at [http://localhost:4200](http://localhost:4200) + ## a11y testing To run a11y tests, run `test_a11y=yes ember serve`