Skip to content

Commit

Permalink
docs: add main folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
felipefialho committed May 15, 2023
1 parent b5718f5 commit 6ff785f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,16 @@ npm run tokens:build
npm run storybook:build
```

## Main folder structure

* `apps/docs`: Contains the main documentation for the project.
* `apps/docs-react`: Provides a React version of Storybook for showcasing components.
* `packages/core`: The core of Atomium, responsible for building all the components.
* `packages/react`: The React version of Atomium, automatically generated by Stencil.
* `packages/tokens`: Contains the design tokens for Atomium, where all the tokens are defined.
* `packages/icons`: Contains the icons used in Atomium, where all the icons are stored.
* `utils/**`: Contains utility modules used throughout the project, providing various helper functions and tools.

## Stories Documentation

We are using [Storybook](https://storybook.js.org/) to document our components.
Expand Down

0 comments on commit 6ff785f

Please sign in to comment.