npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@guardian/mobile-apps-article-templates

v1.0.940

Published

Templates for articles on both iOS and Android next-gen apps

Downloads

3,983

Readme

Article Templates for Mobile Apps

npm version

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.

Requirements

  • A Mac or Linux computer.
  • NVM.
  • NodeJS. Install using nvm: nvm install v10.17.0. Remember to add nvm use v10.17.0 to 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.

Developing

Clone

$ git clone [email protected]:guardian/mobile-apps-article-templates.git

Install

$ 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.js or another module, running npm install -g npm and re-running npm install may fix it.

Running on iOS simulator

  • Checkout the branch you are developing against
  • Run npm run build
  • Checkout the ios-live project
  • Edit the package.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"
}
  • You will then need to run npm install in the ios-live directory that contains the package.json in the repo.

Running on Android simulator

  • Checkout the branch you are developing against
  • Run npm run build
  • Checkout the android-news-app/ project
  • Edit the package.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"
}
  • You will then need to run npm install in the android-news-app/android-news-app directory that contains the package.json in the repo.

Building from S3 (iOS or Android)

  • 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.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 scripts

NPM will provide the following services:

  • npm run test runs the JS unit tests from the test/spec/unit/ directory
  • npm run build builds JS/CSS assets, used on CI environment for building assets
  • npm 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 merged

Publish to npm repository

This repository has changed to changesets to publish the package to NPM package.

  • In your feature branch, run npm run release to generate the changeset file. We usually just bump the patch version number.
  • Add the changeset file generated undder .changeset directory, 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.

Example templates

These are examples of the main templates used across apps:

| Template | Article | | --- | --- | | Article | https://www.theguardian.com/cities/2019/may/31/madrid-set-to-end-clean-air-project-in-rightwing-power-switch | | Podcast | https://www.theguardian.com/news/audio/2019/may/31/trump-coming-to-see-the-queen-but-what-actually-happens-on-a-state-visit-podcast | | Video | https://www.theguardian.com/global/video/2019/may/17/labours-laura-parker-farage-winning-would-be-uks-worst-legacy | | Gallery | https://www.theguardian.com/film/gallery/2019/may/30/the-horror-apocalypse-now-unseen-in-pictures | | Immersive | https://www.theguardian.com/sport/2019/may/31/i-wouldnt-be-the-refugee-id-be-the-girl-who-kicked-ass-how-taekwondo-made-me | | Liveblog | https://www.theguardian.com/sport/live/2019/may/31/west-indies-v-pakistan-cricket-world-cup-2019-live | | Immersive interactive | https://www.theguardian.com/us-news/ng-interactive/2019/may/29/chemical-checkout-what-might-be-hiding-in-your-groceries | | Photo essay | https://www.theguardian.com/society/2019/may/31/amish-on-holiday-sarasota-florida-dina-litovsky-photo-essay | | Guardian labs | https://www.theguardian.com/the-abcs-of-recruiting-teachers-remotely/2020/may/01/the-new-rules-of-remote-recruiting-how-to-prepare-for-an-online-interview |