@steelbird/p3-core

Internal Design System Experiment

This template ships with the latest production-ready tools for design systems.

🚅 Quick start

1. Create the application.

   # Clone the template
   gh repo clone ie/p3-core

2. Install the dependencies.

   Navigate into your new site’s directory and install the necessary dependencies.

   # Navigate to the directory
   cd p3-core
   
   # Install the dependencies
   yarn
   
   # Run storybook
   yarn storybook

Frontend stack

Build components

1. 📚Storybook or UI component development and auto-generated docs
2. ⚛️ React for declarative component-centric UI (via create-react-app)
3. 💅Styled-components for component-scoped styling
4. ✨ Prettier for automatic code formatting

Maintain the system

1. 🚥GitHub Actions for continuous integration
2. 📐ESLint for JavaScript linting
3. ✅ Chromatic to catch visual bugs in components (by Storybook maintainers)
4. 📦npm for distributing the library
5. 🛠Auto for release management workflow

Storybook addons

1. ♿ Accessibility to check for accessibility issues during development
2. 💥 Actions to QA click and tap interactions
3. 🎛 Controls to interactively adjust props to experiment with components
4. 📕 Docs for automatic documentation generation from stories
5. 🔍 Interactions for debugging component interactions
6. 🏎 Test-runner for automated component testing

Contribute

If you encounter an issue with the template, we encourage you to open an issue in this template's repository.