t3n / react-packages Public

Notifications You must be signed in to change notification settings
Fork 3
Star 2

🤖 Packages for developing React components for t3n.de driven by Storybook

react-packages.t3n.vercel.app

2 stars 3 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 2,024 Commits
.circleci		.circleci
.dependabot		.dependabot
.github		.github
packages		packages
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
.npmrc		.npmrc
.prettierignore		.prettierignore
.prettierrc		.prettierrc
Dockerfile		Dockerfile
README.md		README.md
babel.config.js		babel.config.js
jest.config.js		jest.config.js
lerna.json		lerna.json
logo.svg		logo.svg
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Repository files navigation

Table of Contents

Introduction
Setup
- Prerequisites
- Installation
Development
- Tests
Documentation
- Resources
Deployment

Introduction

This monorepo hosts packages necessary for development and documentation of react components in the t3n domain.

The monorepo is structured into four packages:

@t3n/theme
@t3n/components
@t3n/storybook
@t3n/icons
@t3n/configs

Setup

Prerequisites

npm install npm@latest -g

Installation

Clone repo

git clone git@github.com:t3n/react-packages.git

Install NPM packages

npm install

Build packages

npm run build

Run this command from the main package. This will run the build script of each package in the correct order, as @t3n/storybook depends on @t3n/components, which itself depends on @t3n/theme and @t3n/icons.

Development

How to run and develop in this project.

npm run start:storybook

This will start storybook and handle local bundling of packages in the monorepo to enable the quickest development workflow possible. You will then be able to develop components in storybook.

⚠️

Before committing changes, you should ALWAYS run npm run build to generate all types correctly.

Tests

npm run test

Documentation

Resources

To check out all our components you may have a look at https://storybook.t3n.de which hosts the latest version of this package. If you would rather try our components you can fork our CodeSandbox template

Deployment

When your pull request is accepted and merged, go to https://app.circleci.com/pipelines/github/t3n/react-packages and decide whether you want to publish as minor or as patch. If you judge your changes to be a major release, please consult the team first.