Templates for articles on The Guardian iOS and Android apps
Article templates used within the Guardian’s next-generation iOS and Android applications. This repo also contains documentation that describes the components and layouts used across these templates.
nvm install v10.17.0
. Remember to add nvm use v10.17.0
to your preferred shell startup file.npm install -g npm
.Clone
$ git clone [email protected]:guardian/mobile-apps-article-templates.git
Install
$ cd mobile-apps-article-templates
$ npm install
lib/node_modules/npm/node_modules/promise-retry/index.js
or another module, running npm install -g npm
and re-running npm install
may fix it.npm run build
ios-live
projectpackage.json
file in the root of ios-live
, replacing the version of the @guardian/mobile-apps-article-templates
dependency with the relative path of the local templates repo:"dependencies": {
"@guardian/mobile-apps-article-templates": "file:../mobile-apps-article-templates"
}
npm install
in the ios-live
directory that contains the package.json
in the repo.npm run build
android-news-app/
projectpackage.json
file in android-news-app/android-news-app/
, replacing the version of the @guardian/mobile-apps-article-templates
dependency with the relative path of the local templates repo:"dependencies": {
"@guardian/mobile-apps-article-templates": "../../mobile-apps-article-templates"
}
npm install
in the android-news-app/android-news-app
directory that contains the package.json
in the repo.bundle-url.txt
under artifacts
Update your package.json:
"dependencies": {
"@guardian/mobile-apps-article-templates": "https://s3-eu-west-1.amazonaws.com/builds.gutools.co.uk/guardian-mobile-apps-article-templates-v1.0.190.tgz"
}
NPM will provide the following services:
npm run test
runs the JS unit tests from the test/spec/unit/
directorynpm run build
builds JS/CSS assets, used on CI environment for building assetsnpm run dev
builds JS and CSS (with source maps).npm run release
generates a changeset file, which makes changesets
to create a release pull request when the PR is mergedThis repository has changed to changesets
to publish the package to NPM package.
npm run release
to generate the changeset file. We usually just bump the patch version number..changeset
directory, commit and push to githubThese are examples of the main templates used across apps: