Skip to content
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.

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

Update README to include fully local run #896

Merged
merged 6 commits into from
Nov 14, 2023
Merged
Changes from all commits
Commits
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
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

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)
Expand All @@ -43,10 +47,29 @@ 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 locally with a sym-link

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)

```sh
git clone https://github.com/ember-learn/ember-api-docs-data
git clone https://github.com/ember-learn/ember-api-docs
cd ember-api-docs
ln -s ../ember-api-docs-data
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`
Expand Down