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.
- A Mac or Linux computer.
- NVM.
- NodeJS. Install using nvm:
nvm install v10.17.0. Remember to addnvm use v10.17.0to your preferred shell startup file. - You may need to install npm globally
npm install -g npm. - It is recommended you restart your shell to ensure changes added the startup file are applied.
Clone
$ git clone git@github.com:guardian/mobile-apps-article-templates.gitInstall
$ cd mobile-apps-article-templates
$ npm install- If you get an error on this step regarding
lib/node_modules/npm/node_modules/promise-retry/index.jsor another module, runningnpm install -g npmand re-runningnpm installmay fix it.
- Checkout the branch you are developing against
- Run
npm run build - Checkout the
ios-liveproject - Edit the
package.jsonfile in the root ofios-live, replacing the version of the@guardian/mobile-apps-article-templatesdependency with the relative path of the local templates repo:
"dependencies": {
"@guardian/mobile-apps-article-templates": "file:../mobile-apps-article-templates"
}
- You will then need to run
npm installin theios-livedirectory that contains thepackage.jsonin the repo. - If you find that the app is not using the expected version of the dependency (from your branch), try deleting
package-lock.jsonandnode_modulesbefore runningnpm install.
- Checkout the branch you are developing against
- Run
npm run build - Checkout the
android-news-app/project - Edit the
package.jsonfile inandroid-news-app/android-news-app/, replacing the version of the@guardian/mobile-apps-article-templatesdependency with the relative path of the local templates repo:
"dependencies": {
"@guardian/mobile-apps-article-templates": "../../mobile-apps-article-templates"
}
- You will then need to run
npm installin theandroid-news-app/android-news-appdirectory that contains thepackage.jsonin the repo.
- Find the branch you want to test on teamCity
- Click run to build the branch and upload to s3
- You can find the s3 package in
bundle-url.txtunderartifacts
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 testruns the JS unit tests from thetest/spec/unit/directorynpm run buildbuilds JS/CSS assets, used on CI environment for building assetsnpm run devbuilds JS and CSS (with source maps).npm run releasegenerates a changeset file, which makeschangesetsto create a release pull request when the PR is merged
This repository has changed to changesets to publish the package to NPM package.
- In your feature branch, run
npm run releaseto generate the changeset file. We usually just bump the patch version number. - Add the changeset file generated undder
.changesetdirectory, commit and push to github - When your PR is merged, the github action for CI will create a release pull request (example)
- You can merge this release pull request if you want to publish the package to npm repository.
- Alternatively, you may leave the release pull request open. If other PR are merged, their change sets will just be added to this release pull request.
These are examples of the main templates used across apps: