Course Welcome

An Intro to Component Libraries and Design Systems

Syllabus

Environment setup

Introduction

Which React Components to Build? An Atomic Design Guide

Which UI Elements Should be Turned Into React Components?

Choose React Dependencies for a Maintainable Component Library

Shared components

How to Host an NPM Package in GitHub for Free

How to Add Storybook to React to Test Component Library Locally

How to Keep React Code Consistent With Prettier and ESLint

Library creation

Build a Custom React Button Component With forwardRef API

Build a Custom Design System With React Styled Components

Validate React Props With PropTypes and TypeScript

Shared component patterns

How to Design Compound Components With React Context

How to Design Custom React Field Components With useUniqueID

How to Extend Styled Component Styles With New Style Props

Advanced patterns

How to Test React Component Libraries With ts-jest

How to Build Tests For React Button Components

How to Build Accessibility Tests For React Field Components

Component testing

The Best Ways to Bundle React Modules Into Packages

How to Configure Babel and RollupJS for React Storybook

How to Add TypeScript Declarations to a React Build Process

Build process

Setting Up Continuous Integration for a React Component Library With GitHub Actions

How to Start a GitHub Publish Workflow With a Private Repository

How to Import a Custom Component Library Into a React Project

Deployment and automation

react

node.js

typescript

storybook

This course will teach you how to create a flexible, private, enterprise-grade component library using React.

Since its introduction in 2013, React has become one of the [most used front-end frameworks](https://2019.stateofjs.com/front-end-frameworks/). Its component-based architecture and flexibility has made it the framework of choice for those needing to share code across multiple teams.

However, the same flexibility that has helped React grow in popularity also creates many challenges when creating shared assets and tooling. Some of the most commonly asked questions include:

- What components should be shared?
- How do I choose which dependencies to include in my library?
- Which component APIs and design patterns allow for the most flexibility?
- How do I document and build my components?
- How should I be testing my library?
- Where do I deploy my components for internal use?

This course will teach you how to create a flexible, private, enterprise-grade
component library using React.

The newline Guide to Building a Company Component Library

How to identify potential shared components in an existing codebase

Importance of choosing your libraries dependencies

How to create an NPM library from scratch with TypeScript and Storybook

Basic and advanced API patterns for shared components

How to build and deploy a modern NPM package to a private NPM registry

With our library now published to our internal package registry, we can consume our component library in another application. To test this functionality we will be replacing the demo elements within the 

Since our library isn't available in the public NPM registry we will need to 

configure our local environment to authenticate with GitHub

//npm.pkg.github.com/:_authToken=ACCESS_TOKEN
@GITHUBUSERNAME:registry=https://npm.pkg.github.com

 is updated to match your GitHub organization or account name. For my library this will be 

 packages are retrieved with the GitHub registry while all others use the public NPM registry.

Once the configuration file is created we must create a new 

 to authenticate with GitHub. This token should only contain the 

 so that our secret is not added to source control.

---
title: How to Import a Custom Component Library Into a React Project
privateVideoUrl: https://fullstack.wistia.com/medias/pc86mk0t80
---

With our library now published to our internal package registry, we can consume our component library in another application. To test this functionality we will be replacing the demo elements within the `demo-styleguide` codebase.

Since our library isn't available in the public NPM registry we will need to [configure our local environment to authenticate with GitHub](https://docs.github.com/en/packages/guides/configuring-npm-for-use-with-github-packages).

## NPM configuration

Within the `demo-styleguide` codebase, add a new `.npmrc` file with the following content.

```bash
cd ./demo-styleguide
touch .npmrc
```

```txt
//npm.pkg.github.com/:_authToken=ACCESS_TOKEN
@GITHUBUSERNAME:registry=https://npm.pkg.github.com
```

**IMPORTANT:** Ensure that `@GITHUBUSERNAME` is updated to match your GitHub organization or account name. For my library this will be `@austingreendev`. This config ensures that any `@GITHUBUSERNAME/*` packages are retrieved with the GitHub registry while all others use the public NPM registry.

Once the configuration file is created we must create a new [Personal Access Token](https://github.com/settings/tokens/new) to authenticate with GitHub. This token should only contain the `read:packages` scope.

![Personal access token](https://d2uusema5elisf.cloudfront.net/courses/newline-guide-to-building-a-company-component-library/module_07/lesson_07_03/public/assets/token.png)

Once created, update `ACCESS_TOKEN` with this provided value. Ensure that `.npmrc` is added to your `.gitignore` so that our secret is not added to source control.

Learn

The newline Guide to Building Your First GraphQL Server with Node and TypeScript

Teach

Amelia Wattenberger

Author of Fullstack D3

Community

The newline Guide to Building a Company Component Library

Module 1: Introduction

Introduction:

Start Here

Introduction: (2:36)

Course Welcome

Introduction: (1:44)

An Intro to Component Libraries and Design Systems

Introduction: (1:23)

Syllabus

Introduction: (0:49)

Environment setup

Module 2: Shared components

Lesson 1: (2:04)

Which React Components to Build? An Atomic Design Guide

Lesson 2: (4:30)

Which UI Elements Should be Turned Into React Components?

Lesson 3: (2:22)

Choose React Dependencies for a Maintainable Component Library

Module 3: Library creation

Lesson 1: (4:37)

How to Host an NPM Package in GitHub for Free

Lesson 2: (4:46)

How to Add Storybook to React to Test Component Library Locally

Lesson 3: (4:55)

How to Keep React Code Consistent With Prettier and ESLint

Module 4: Shared component patterns

Lesson 1: (7:49)

Build a Custom React Button Component With forwardRef API

Lesson 2: (13:39)

Build a Custom Design System With React Styled Components

Lesson 3: (2:05)

Validate React Props With PropTypes and TypeScript

Module 5: Advanced patterns

Lesson 1: (2:09)

How to Design Compound Components With React Context

Lesson 2: (15:48)

How to Design Custom React Field Components With useUniqueID

Lesson 3: (7:51)

How to Extend Styled Component Styles With New Style Props

Module 6: Component testing

Lesson 1: (2:45)

How to Test React Component Libraries With ts-jest

Lesson 2: (5:13)

How to Build Tests For React Button Components

Lesson 3: (4:51)

How to Build Accessibility Tests For React Field Components

Module 7: Build process

Lesson 1: (2:55)

The Best Ways to Bundle React Modules Into Packages

Lesson 2: (8:10)

How to Configure Babel and RollupJS for React Storybook

Lesson 3: (2:17)

How to Add TypeScript Declarations to a React Build Process

Module 8: Deployment and automation

Lesson 1: (3:17)

Setting Up Continuous Integration for a React Component Library With GitHub Actions

Lesson 2: (1:28)

How to Start a GitHub Publish Workflow With a Private Repository

Lesson 3: (4:50)

How to Import a Custom Component Library Into a React Project

How to Import a Custom Component Library Into a React Project