Skip to content

Update the readme: remove an npm, add info about running frontend with fixtures #530

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

Merged
merged 2 commits into from
Jan 29, 2017
Merged

Update the readme: remove an npm, add info about running frontend with fixtures #530

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d6a007
Change one last reference of `npm` to `yarn`
carols10cents Jan 27, 2017
618cd6f
Add a note about running frontend with test fixture data
carols10cents Jan 29, 2017
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
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,18 @@ yarn run start:staging
This will run a local frontend using the staging backend (hosted on Heroku at
[staging-crates-io.herokuapp.com](https://staging-crates-io.herokuapp.com)).

If you'd like to run the frontend with a specific backend endpoint, you can
specify arguments to `npm start`. For example you can set the proxy to
`https://crates.io/` to use the production version.
If you want to set up a particular situation, you can edit the fixture data used
for tests in `app/mirage/fixtures`. Note that the fixture data does not contain
JSON needed to support every page, so some pages might not load correctly. To
run the frontend and use that data, don't specify any backend:

```bash
yarn run start
```

If you'd like to run the frontend with a specific backend endpoint, you can
specify arguments to `yarn start`. For example you can set the proxy to
`https://crates.io/` to use the production version.

**Note: it is also possible to make changes to the production data**

Expand Down