Skip to content

Commit

Permalink
chore: update README (#36)
Browse files Browse the repository at this point in the history
* add better native instructions for dev environment

* fix the native storybook instructions and remove a global dependency

* fix the contributing link

relative links are fine: https://help.github.com/articles/about-readmes/
  • Loading branch information
trevorah authored and craigbilner committed Jul 4, 2017
1 parent f12bdac commit c317d43
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,23 @@ Home of The Times' `react`/`react native` components, using

### Dev Environment

It's been developed almost solely on MacOS so there may be issues elsewhere
We require MacOS with [node.js](https://nodejs.org), [yarn](https://yarnpkg.com) and [watchman](https://facebook.github.io/watchman) installed. Native development requires [Xcode](https://developer.apple.com/xcode) and [Android Studio](https://developer.android.com/studio/index.html).

You can try without these requirements, but you'd be on your own.

## Getting Started

1. Install `yarn` with `npm i yarn -g` or `brew install yarn`
2. Run `yarn`
3. components can be seen running in a storybook:
1. Run `yarn` to install dependencies
2. components can be seen running in a storybook:
* web storybook
1. `yarn run storybook`
1. `yarn storybook`
2. go to http://localhost:9001
* native storybook
1. `react-native run-android` or `react-native run-ios` to start an emulator
2. `yarn run storybook-native`
1. `yarn storybook-native` and leave it running
2. `yarn ios` and/or `yarn android` to start the (sim|em)ulators
3. go to http://localhost:7007

## Contributing

See the [CONTRIBUTING.md](https://github.com/newsuk/times-components/blob/master/CONTRIBUTING.md)
See the [CONTRIBUTING.md](.github/CONTRIBUTING.md)
for an extensive breakdown of the project
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@
"coverage": "lcov-result-merger ./packages/**/lcov.info ./lcov.info",
"test": "jest ./lib && lerna run test && npm run coverage && cat ./lcov.info | ./node_modules/coveralls/bin/coveralls.js",
"storybook": "start-storybook -p 9001 -c .storybook",
"prestorybook-native": "node ./node_modules/.bin/rnstl",
"storybook-native": "storybook -c .storybook.native start -p 7007",
"storybook:build": "build-storybook -c .storybook",
"storybook:publish": "./lib/publish_storybook.sh",
"prestorybook-native": "node ./node_modules/.bin/rnstl",
"storybook-native": "storybook -c .storybook.native start -p 7007",
"ios": "react-native run-ios",
"android": "react-native run-android",
"prettier:diff": "prettier --list-different 'packages/*/*.js'",
"prettier:write": "prettier --write 'packages/*/*.js'",
"lint-staged": "lint-staged",
Expand Down

0 comments on commit c317d43

Please sign in to comment.