guardian-mobile-apps-article-templates v1.0.5

Article Templates for Mobile Apps

Article templates used within the Guardian’s next-generation iOS, Android and Windows applications. This repo also contains documentation that describes the components and layouts used across these templates.

Requirements

• A Mac or Linux computer.
• brew as a package manager.
• NVM.
• NodeJS. Install using nvm: nvm install v6.9.2. Remember to add nvm use v6.9.2 to your preferred shell startup file.
• Yarn. Yarn is a package manager. Install using brew install yarn.
• It is recommended you restart your shell to ensure changes added the startup file are applied.

Developing

• checkout the project in a separate directory, outside the iOS and the Android app.
• copy config.sample.js to config.js and fill in the details
  • base.android is the 'ArticleTemplate' path within the Android app, eg: /Users/sandropaganotti/Projects/android-news-app/android-news-app/src/main/assets/templates/
  • base.ios is the 'ArticleTemplate' path within the iOS app, eg: /Users/sandropaganotti/Projects/ios-live/mobile-apps-article-templates/ArticleTemplates/
  • base.html is the path where this repository has been checked out, eg: /Users/sandropaganotti/Projects/mobile-apps-article-templates/
• run yarn to install dependencies.
• run yarn setup to locally ignore build files so they are not checked into master

IOS and Android devs

If you are developing against a branch which is not release, please follow the steps below:

• Pull down the branch which you are developing against
• Please follow the requirements and developing steps
• run yarn sync which will build the project, and move the build into the individual Android and IOS projects

Yarn scripts

Yarn will provide the following services:

• yarn test runs the JS unit tests from the test/spec/unit/ directory
• yarn validate runs sasslint checks on SCSS and jshint checks on JS
• yarn build builds JS/CSS assets, used on CI environment for building assets
• yarn develop builds JS/CSS assets and watches for changes to JS/CSS. If changes then rebuilds and copies assets to iOS/Android to the iOS and Android projects as specified in config.js

deploying

How to deploy