Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Development

Christophe Camel edited this page Aug 5, 2022 · 3 revisions

πŸ’» Local Development

Please git clone the okp4/ui project, then:

$ yarn      # install all dependencies
$ yarn dev  # launch the app

Finally, you can visit the app http://localhost:6006/.

🧬 Atomic Design Methodology

The OKP4 Design System follows the Atomic Design Methodology.

It is important to fully understand its principles in order to build components adapted to our design system: you can learn more here.

🌳 Folders Tree

The files are separated into two parts:

  • a ui part which contains the code of the react components
  • a stories part which contains the description related to each component created in UI
.
β”œβ”€β”€ src
β”‚   β”œβ”€β”€ adapters
β”‚   β”œβ”€β”€ assets      # icons/images/logos for components   
β”‚   β”œβ”€β”€ domain
β”‚   β”œβ”€β”€ event
β”‚   β”œβ”€β”€ hook
β”‚   β”œβ”€β”€ i18n
β”‚   └── ui
└── stories.        # storybook code
    β”œβ”€β”€ assets.     # icons/images/logos for stories
    β”œβ”€β”€ atoms
    β”œβ”€β”€ molecules
    β”œβ”€β”€ templates
    └── pages