diff --git a/INSTALL.md b/INSTALL.md index faee7bb25..f5f82f294 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -27,7 +27,7 @@ Navigate to a directory. ``` git clone https://github.com/coralproject/talk cd talk -npm install +yarn install ``` ### Environmental Variables @@ -42,7 +42,7 @@ Talk uses environmental variables for configuration. You can learn about them in Starting the server: ``` -npm start +yarn start ``` Browse to `http://localhost:3000` (or your custom port.) @@ -54,13 +54,13 @@ Our build process will build all front end components registered [here](https:// One time build: ``` -npm build +yarn build ``` Build, then rebuild when a file is updated (development build): ``` -npm build-watch +yarn build-watch ``` @@ -69,13 +69,13 @@ npm build-watch Run all tests once: ` -npm test +yarn test ` Run our end to end tests (will install Selenium and nightwatch): ` -npm run e2e +yarn e2e ` _Please ensure all tests are passing before submitting a PR!_ diff --git a/client/coral-admin/README.md b/client/coral-admin/README.md index 067a3cac9..7bc9de36e 100644 --- a/client/coral-admin/README.md +++ b/client/coral-admin/README.md @@ -5,19 +5,19 @@ This app handles moderation for Talk (and maybe more later on) ## Installation - $ npm install + $ yarn install $ cp config.sample.json config.json Then change `config.json` to adjust it to your project ## Building for production - $ npm run build + $ yarn build The public folder has everything you need for deployment. You can just copy that folder to your favorite static web server ## Development - $ npm start + $ yarn start A development server will be running at http://localhost:4132 diff --git a/docs/frontend/README.md b/docs/frontend/README.md index 4e7f34fd6..083b776e0 100644 --- a/docs/frontend/README.md +++ b/docs/frontend/README.md @@ -112,7 +112,7 @@ http://eslint.org/docs/rules/#best-practices ## Lint the code ```js -npm run lint +yarn lint ``` diff --git a/docs/frontend/TEST.md b/docs/frontend/TEST.md index 92a1f1998..0ce5a47bf 100644 --- a/docs/frontend/TEST.md +++ b/docs/frontend/TEST.md @@ -71,10 +71,10 @@ The `pree2e` script will create 3 users: a Commenter, a Moderator, and an Admin ## Run the tests Run Talk -`dotenv npm run start` +`dotenv yarn start` Run e2e tests -`npm run e2e` +`yarn e2e` ## Advanced Nightwatch and Selenium Settings