broadsheet v0.0.1

The Times Component Library

Purpose

Home of The Times' react/react native components, using react-native-web to share across platforms

Dev Environment

We require MacOS with Node.js (version >=8 with npm v5), yarn (latest) and watchman installed. Native development requires Xcode and Android Studio.

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

Getting Started

1. Run yarn to install dependencies
2. components can be seen running in a storybook:

• web storybook
  1. yarn storybook
  2. go to http://localhost:9001
• native storybook
  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

⚠️ Native Storybook ⚠️

In order to view the storybook on native, you'll need to fix a broken font which requires fontforge

brew install fontforge

When you first get a local copy of the fonts you may see some warnings which you can ignore

Contributing

See the CONTRIBUTING.md for an extensive breakdown of the project