@@ -88,7 +88,7 @@ as well.
8888In order to run the frontend on Windows and macOS, you will need to have installed:
8989
9090- [ node] ( https://nodejs.org/en/ ) >= 12.9.1 (see ` package.json ` and ` .github/workflows/ci.yml ` for what we currently use)
91- - [ npm ] ( https://www.npmjs .com/get-npm ) >= 6.10.2
91+ - [ yarn ] ( https://classic.yarnpkg .com/en/docs/install ) v1.x
9292
9393Follow the links for each of these tools for their recommended installation
9494instructions. If you already have these tools, or you have a different
@@ -105,25 +105,25 @@ into any trouble.
105105To install the npm packages that crates.io uses, run:
106106
107107```
108- npm install
108+ yarn install
109109```
110110
111111You'll need to run these commands any time the libraries or versions of these
112112libraries that crates.io uses change. Usually you'll know they've changed
113113because you'll run the next step and it will fail saying it can't find some
114114libraries.
115115
116- To build and serve the frontend assets, use the command ` npm run start` . There
116+ To build and serve the frontend assets, use the command ` yarn start` . There
117117are variations on this command that change which backend your frontend tries to
118118talk to:
119119
120120| Command | Backend | Use case |
121121| ---------| ---------| ----------|
122- | ` npm run start:live` | https://crates.io | Testing UI changes with the full live site's data |
123- | ` npm run start:staging` | https://staging-crates-io.herokuapp.com | Testing UI changes with a smaller set of realistic data |
124- | ` npm run start` | Static fixture test data in ` mirage/fixtures ` | Setting up particular situations, see note |
125- | ` npm run start:local` | Backend server running locally | See the Working on the backend section for setup |
126- | ` npm run start -- --proxy https://crates.io` | Whatever is specified in ` --proxy ` arg | If your use case is not covered here |
122+ | ` yarn start:live` | https://crates.io | Testing UI changes with the full live site's data |
123+ | ` yarn start:staging` | https://staging-crates-io.herokuapp.com | Testing UI changes with a smaller set of realistic data |
124+ | ` yarn start` | Static fixture test data in ` mirage/fixtures ` | Setting up particular situations, see note |
125+ | ` yarn start:local` | Backend server running locally | See the Working on the backend section for setup |
126+ | ` yarn start -- --proxy https://crates.io` | Whatever is specified in ` --proxy ` arg | If your use case is not covered here |
127127
128128> Note: If you want to set up a particular situation, you can edit the fixture
129129> data used for tests in ` mirage/fixtures ` . The fixture data does not currently
@@ -135,7 +135,7 @@ talk to:
135135You can run the frontend tests with:
136136
137137```
138- npm test
138+ yarn test
139139```
140140
141141### Working on the Backend
@@ -362,7 +362,7 @@ without a restart needed, and you can leave the frontend running while you
362362restart the server):
363363
364364```
365- npm run start: local
365+ yarn start: local
366366```
367367
368368And then you should be able to visit http://localhost:4200!
0 commit comments