From a97ac3ebefbb457d0f7e350d76ac31ab441ad43b Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 17:27:54 -0500 Subject: [PATCH 1/6] 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` From 387b9a7d58c482589c2bd1ad1dabfd8ac4fce8ea Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 17:44:13 -0500 Subject: [PATCH 2/6] fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cee58789..fb44a41f 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ The Prembered version of the ember-api-docs expects a folder in its root that li 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/) +- [ember-api-docs-data](https://github.com/ember-learn/ember-api-docs-data) ```sh git clone https://github.com/ember-learn/ember-api-docs-data From b373fb0b608b9e98cd73bfefb1b285eadc48c7b3 Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 17:56:23 -0500 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb44a41f..c99ccbc4 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ 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 +ln -s ../ember-api-docs-data npm install npm start ``` From fc8c07fc6bc8b62d70600390180769c670f67c1b Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 18:43:25 -0500 Subject: [PATCH 4/6] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c99ccbc4..08476b5e 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,11 @@ Some tips for working with git/GitHub can be found in Please also see [CONTRIBUTING.md](CONTRIBUTING.md). -## Quickstart to run semi-locally +## Running in your local environment + +The Prembered version of the ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so you can either use the `npm run clone` script to clone the `ember-api-docs-data` repo into `ember-api-docs`, OR you can create a symbolic link to `ember-api-docs-data` from `ember-api-docs`. You might want to sym-link `ember-api-docs-data` if you are generating new versions of the docs files with `ember-jsonapi-docs`, otherwise you can probably use the clone script. + +### Quickstart to run locally Follow these instructions to run the app using publically available online data. You do not need to run [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs) @@ -43,15 +47,14 @@ locally yourself. git clone https://github.com/ember-learn/ember-api-docs.git cd ember-api-docs npm install -ember serve +npm run clone +npm run start ``` 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. +### Run locally with a sym-link -Clone all of the following repositories into the same directory so they are "siblings" on the file system +Clone all of the following repositories into the same directory so they are "siblings" on the file system: - This repository, `ember-api-docs` - [ember-api-docs-data](https://github.com/ember-learn/ember-api-docs-data) From 2651f91221c54a21c72dbfe142321514c0eaec71 Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Sat, 11 Nov 2023 19:00:09 -0500 Subject: [PATCH 5/6] Update README.md Co-authored-by: Chris Manson --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 08476b5e..0d3f012e 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Please also see [CONTRIBUTING.md](CONTRIBUTING.md). ## Running in your local environment -The Prembered version of the ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so you can either use the `npm run clone` script to clone the `ember-api-docs-data` repo into `ember-api-docs`, OR you can create a symbolic link to `ember-api-docs-data` from `ember-api-docs`. You might want to sym-link `ember-api-docs-data` if you are generating new versions of the docs files with `ember-jsonapi-docs`, otherwise you can probably use the clone script. +ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so you can either use the `npm run clone` script to clone the `ember-api-docs-data` repo into `ember-api-docs`, OR you can create a symbolic link to `ember-api-docs-data` from `ember-api-docs`. You might want to sym-link `ember-api-docs-data` if you are generating new versions of the docs files with `ember-jsonapi-docs`, otherwise you can probably use the clone script. ### Quickstart to run locally From c55a9562358d7251a73c14441429190db54fccc6 Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Sat, 11 Nov 2023 19:00:20 -0500 Subject: [PATCH 6/6] Update README.md Co-authored-by: Chris Manson --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 0d3f012e..6de74a54 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,6 @@ Clone all of the following repositories into the same directory so they are "sib ```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