Skip to content

times/graphics-components

Repository files navigation

📰 The Times Graphics Components

Welcome to The Times Graphics Components, a collection of React-based components designed for interactive graphics and data visualizations.

The Times


⚠️ Requirements

This library requires React 19 or higher.
Please make sure your project is using React 19+ to avoid runtime errors related to JSX transformations.


🚀 Installation

To install the dependencies, run:

yarn install

🔐 Internal Usage Only

This package is published to GitHub Packages under the @times scope, and is intended for internal use by teams at The Times / NewsCorp only.

Local development setup

To install this package locally, you need:

  1. A GitHub personal access token (classic) with read:packages permission
  2. A .npmrc file configured like this:
@times:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
registry=https://registry.npmjs.org/

🏗 Development

To start the Storybook environment:

yarn storybook

📦 Deployment

To deploy Storybook to GitHub Pages:

yarn deploy-storybook

🤝 Contributing

We welcome contributions! To contribute:

  1. Fork the repository.
  2. Create a new branch:
   git checkout -b feature-branch
  1. Run ESLint and fix issues before committing:
   yarn lint
  1. Make your changes and commit them::
   git commit -m "Add new feature"
  1. Push to your branch::
   git push origin feature-branch
  1. Open a pull request on GitHub.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published