plank-components-nas

Plank Components Library

This template ships with the main React and Storybook configuration files you'll need to get up and running fast.

🚅 Quick start

1. Create the application.

   # Clone the template
   git clone [e-mail]:plank/plank-components.git

2. Install the dependencies.

   Navigate into your new site’s directory and install the necessary dependencies.

   # Navigate to the directory
   cd plank-components/
   
   # Install the dependencies
   yarn

3. Open the source code and start editing!

   Open the plank-components directory in your code editor of choice and building your first component!

4. Browse your stories!

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

🔎 What's inside?

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

.
├── .storybook
├── node_modules
├── public
├── src
├── .env
├── .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. .env: Simple text configuration file for controlling the application's environment constants.

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

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

8. 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.

9. 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).

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

Contribute

If you encounter an issue with the template, we encourage you to open an issue in this template's repository.

Learning Storybook

1. Read the 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 official documentation at Storybook.