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

Build process

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

Deployment and automation

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

 which allows us to create private repositories, run a CI/CD environment, and host private NPM packages. The first step for our new component library is to 

Once the repository is created, let's clone it to our machine.

# Navigate to where you want to store the repository
cd ~/Courses

# Use the HTTPS or SSH values provided by GitHub
git clone COPY_FROM_GITHUB

When the repository is finished cloning, open it in your editor of choice. You should see the 

To help the initial package creation we will use the 

# Navigate to our component library
cd ~/Courses/component-library

# Initialize our package with all default values
npm init --force

 with its values pre-populated to match our repository. Let's update the name of the package to include our GitHub account as a scope:

// File: package.json

{
  "name": "@GITHUBUSERNAME/component-library",
  "version": "0.0.0"
}

---
title: How to Host an NPM Package in GitHub for Free
privateVideoUrl: https://fullstack.wistia.com/medias/jnftkrc4hf
---

## Create GitHub repository

GitHub has a [generous free plan](https://github.com/pricing) which allows us to create private repositories, run a CI/CD environment, and host private NPM packages. The first step for our new component library is to [create a private GitHub repository](https://github.com/new).

![Create new GitHub repository](https://d2uusema5elisf.cloudfront.net/courses/newline-guide-to-building-a-company-component-library/module_03/lesson_03.01/public/assets/new-github-repository.png)

Repository details:

-   **Owner**

    -   Use your GitHub username
    -   If your company uses GitHub you may create this package under their organization when creating a component library for production
-   **Name**

    -   Use `component-library`
-   **Permissions**

    -   Make sure the repository is listed as `PRIVATE`
-   **README / .gitignore**

    -   Provide a default `README` as well as the `Node .gitignore` template

## Clone repository

Once the repository is created, let's clone it to our machine.

```bash
# Navigate to where you want to store the repository
cd ~/Courses

# Use the HTTPS or SSH values provided by GitHub
git clone COPY_FROM_GITHUB
```

When the repository is finished cloning, open it in your editor of choice. You should see the `README` and `.gitignore` we defined in the previous step.

![empty package](https://d2uusema5elisf.cloudfront.net/courses/newline-guide-to-building-a-company-component-library/module_03/lesson_03.01/public/assets/empty-package.png)

## Initialize the package

To help the initial package creation we will use the [npm-init](https://docs.npmjs.com/cli/v7/commands/npm-init) command.

```bash
# Navigate to our component library
cd ~/Courses/component-library

# Initialize our package with all default values
npm init --force
```

You will see a new `package.json` with its values pre-populated to match our repository. Let's update the name of the package to include our GitHub account as a scope:

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:52)

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

Module 8: Deployment and automation

Lesson 1: (3:18)

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

How to Host an NPM Package in GitHub for Free