Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

@bbc/digital-paper-edit-storybook

v1.29.0

Published

3 months ago

[The Storybook](https://bbc.github.io/digital-paper-edit-storybook/?path=/story/breadcrumb--projects)

Downloads

58

Digital Paper Edit - React Components Catalogue

---> Work in progress <--

! What is published in the Storybook may be different to what is being actively used in Digital-Paper-Edit-Client, as the components are currently being migrated. !

This repository uses storybook to gather the components of the React front end. You can read about the "why" in this ADR.

See here for the overall project architecture.

Setup

git clone [email protected]:bbc/digital-paper-edit-storybook.git

cd digital-paper-edit-storybook

Optional step to setup nvm to use node version 10, otherwise just use node version 10

nvm use || nvm install

in root of project

npm install

Usage - development

Start the storybook

npm start

Storybook is at http://localhost:6006/

Linking storybook to the Firebase app for development

In this repo, run:

npm run link:setup

In another terminal window:

npm run link

When finished, run:

npm run unlink

Usage - production

npm install @bbc/digital-paper-edit-storybook

System Architecture

uses storybook with the setup as explained in their docs to develop this React.
.storybook/webpack.config.js changes the storybook webpack config to add support for css modules.

Development env

npm > 6.1.0
Node 10 - dubnium

Node version is set in node version manager .nvmrc

Build

To transpile ./src and create a build in the ./dist folder, run:

npm run build

Demo & storybook

Storybook can bew viewed at https://bbc.github.io/digital-paper-edit-storybook/
Demo can be viewed at https://bbc.github.io/digital-paper-edit-client

Build - storybook

To build the storybook as a static site

npm run build-storybook

Publish storybook & demo to github pages

This github repository uses github pages to host the storybook and the demo of the component. Make sure to commit and push any changes to MASTER before deploying to github pages.

npm run publish-ghpages

Alternatively, if you simply want to build the demo locally in the build folder then just

npm run build-storybook

Tests

Test coverage using jest, to run tests

npm run test

Travis CI

On commit, - this repo uses the .travis.yml config to run the automated test on travis CI.

Deployment

NPM

Note that only README.md and the dist folders are published to NPM.

New releases

Go into the release branch and pull the new changes from master.
Commit or push changes to the remote branch of release
Find corresponding changes in Travis

If you had to make changes in release, make sure that the release is equivalent to master!

Locally, using the NPM cli

To push to npm - @bbc/digital-paper-edit-storybook

login into npm

npm run publish-public

This runs npm run build and npm publish --access public under the hood

Contributing

See CONTRIBUTING.md guidelines and CODE_OF_CONDUCT.md guidelines.

Licence

Legal Disclaimer

Despite using React, the BBC is not promoting any Facebook products or other commercial interest.