Skip to content

Latest commit

 

History

History
159 lines (109 loc) · 4.73 KB

README.md

File metadata and controls

159 lines (109 loc) · 4.73 KB

Json Form Schema (Design) Pattern

A deep dive into the Json Form Schema (Design) Pattern. See storybook intro doc for more info. This is a learning resource.

Setup

Assuming you have your mac setup already with git, node and yarn.

Pull the repo

git clone git@github.com:pietrop/json-form-schema-design-pattern.git

Go into the folder

cd json-form-schema-design-pattern

Install dependencies

yarn

Usage

Run

yarn storybook

to see your component's stories at http://localhost:6006

or

yarn storybook-docs

System Architecture

For system architecture of the design pattern See Storybook

System Architecture docs from the storybook boostrap that ues CRA see here

See Storybook Architecture mdx doc

The Project itself was initially scaffolded using Storybook Tutorials

🔎 What's inside?

A quick look at the top-level files and directories included with this template.

.
├── .storybook
├── node_modules
├── public
├── src
├── .gitignore
├── LICENSE
├── package.json
├── yarn.lock
└── README.md

  1. .storybook: This directory contains Storybook's configuration files.

  2. node_modules: This directory contains all of the modules of code that your project depends on (npm packages).

  3. public: This directory will contain the development and production build of the site.

  4. src: This directory will contain all of the code related to what you will see on your application.

  5. .gitignore: This file tells git which files it should not track or maintain during the development process of your project.

  6. LICENSE: The template is licensed under the MIT licence.

  7. package.json: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project.

  8. yarn.lock: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (Do not change it manually).

  9. README.md: A text file containing useful reference information about the project.

Learning Storybook

  1. Read our introductory tutorial at Learn Storybook.
  2. Learn how to transform your component libraries into design systems in our Design Systems for Developers tutorial.
  3. See our official documentation at Storybook.

Documentation

See Storybook

Development env

Node version is set in node version manager .nvmrc

nvm use

Build

yarn build-storybook

or

yarn build-storybook-docs

Tests

yarn test

Deployment

To update the github pages storybook docs

yarn deploy:ghpages