Project overview

Our project structure

Most of the business logic is organized into smaller packages. This could be one component or a couple of related components.

.
├── ...
├── src              # This folder contains the primary packages.
│   ├── button       # A package's root folder
│   ├── stratus-core # Package that contains global logics and utilities
│   └── ...
├── docs             # Stratus website and site plugins
└── ...
Copy

#Co-location structure

We store all the related files in one package. A package contains all the tests, styles, documentation, etc. in its own folder:

button
├── __docs__
│   └── Button.mdx            # The documentation file for the component
├── __tests__
│   └── Button.spec.tsx       # Test file for the component
├── __stories__
│   └── Button.stories.tsx    # Storybook example of the component
├── components
│   ├── Button.tsx            # A component main source file
│   └── Button.style.ts       # Emotion styled components
├── hooks                     # If the component needs hook you can place it here
└── index.ts                  # Export all the components and hooks here
Copy

#Next up

• Work on Stratus