0.1.4 β€’ Published 2 years ago

@steelbird/p2-core v0.1.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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/p2-core
  2. Install the dependencies.

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

    # Navigate to the directory
    cd p2-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.