npm package: @siliconvalleybank/dimension-example-component-library
Description: React component library with components generated and/or composed with Figmagic. Made for The newline Guide to React Component Design Systems with Figmagic.
Author: Mikael Vesavuori
Latest version: 0.0.1

# ACME Corp. Potted Plants - Component Library (Starter)

**This is the starter package that recreates the [final result](https://github.com/mikaelvesavuori/acmecorp-potted-plants-components)**.

React component library with components generated and/or composed with Figmagic. Made for [The newline Guide to React Component Design Systems with Figmagic](https://www.newline.co/courses/newline-guide-to-react-component-design-systems-with-figmagic/).

In the context of the course, it's meant to be used with our [example application](https://github.com/mikaelvesavuori/acmecorp-potted-plants-app).

## Technology

- [Figmagic](https://github.com/mikaelvesavuori/figmagic)
- React
- Styled Components
- Webpack
- ESLint
- Prettier
- Babel

## Instructions

- Initialize the project with `npm run init`, which will:
  - Install dependencies with `npm install --force` (important, as regular install will not work correctly)
- Run Storybook with `npm start`
- Create a `.env` file that contains values for `FIGMA_URL`, `FIGMA_TOKEN` and `CHROMATIC_TOKEN`

## Structure

- `/.storybook`: Storybook configuration
- `/src/index.jsx`: Component exports
- `/src/utils.js`: Basic JavaScript utility functions
- `/src/components`: Manually composed complex React components
- `/src/elements`: Figmagic-generated React components ("elements")
- `/src/graphics`: Figmagic-generated graphics
- `/src/tokens`: Figmagic-generated design tokens

## Component architecture

The very short version is that `elements` are generated files. Here we only change React and/or Styled Components files, so they can be styled correctly and can become functional.

In `components` we compose new items out of the elements and whatever wrapping code we might need, with DIVs and CSS etc.

## Provided components

All component code is provided for you, and the course should refer to the very same code you find here.

### Demo

We will recreate this in the course.

- Demo

### Products view

- ProductCard
- CartButton

### Checkout view

- FormInput
- CheckoutForm
- CheckoutItem
- IconButton

## Provided elements

These will be recreated in the course.

- Button
- Card
- CartSymbol
- Description
- Footer
- Form
- Header
- Heading
- Image
- Input
- Minus
- Plus

## Building your own components

Starting with the course, you should move out the `src/components` folder to the root (or delete it) so you can see the more basic elements working on their own first.

Same goes for tokens, elements and graphics. A recommendation would be to keep all the pre-provided code in a folder in the root so you can eyeball it in case you wonder how something was originally built.

## Files that you will modify after generating them

Files that will be modified while doing the course:

- **Button**: `src/elements/Button/Button.js`
- **Button**: `src/elements/Button/ButtonStyled.js`
- **Card**: `src/elements/Card/CardStyled.js`
- **Card**: `src/elements/Card/Card.stories.mdx`
- **Description**: `src/elements/Description/DescriptionStyled.js`
- **Footer**: `src/elements/Footer/FooterStyled.js`
- **Heading**: `src/elements/Heading/HeadingStyled.js`
- **Image**: `src/elements/Image/Image.js`
- **Image**: `src/elements/Image/ImageStyled.js`
- **Image**: `src/elements/Image/Image.stories.mdx`
- **Input**: `src/elements/Input/Input.js`
- **Input**: `src/elements/Input/InputStyled.js`
- **Label**: `src/elements/Label/LabelStyled.js`
- **Form**: `src/elements/Form/FormStyled.js`

## Figmagic configuration

You need to set the `FIGMA_URL` and `FIGMA_TOKEN`, for example in an `.env` file.

The provided configuration at `figmagic.json` should be a good starting point.

_Remember to have your `overwrite` object correctly set up if you expect to modify the generated files! The provided config will overwrite anything except the React and Styled Components files._