mindedge-laika v0.1.4

🚅 Quick start

1. Install the dependencies.

   Navigate into the repo’s root directory and install the necessary dependencies.

   # Navigate to the directory
   cd laika/
   
   # Install the dependencies
   yarn

2. To work in storybook run the following to serve the site

   In the root directory of the project, run yarn storybook to see the component's stories at http://localhost:6006

3. Testing

   Run yarn test to run Jest testing

4. Styling

   Keep styles specific to components scoped to those components. Global styles should be imported into storybook. This version of storybook is set up to work with sass and normal css.

🔎 What's inside?

A quick look at the top-level files and directories

.
├── .storybook
├── node_modules
├── public
├── src
├── tests
├── .browserslistrc
├── .eslintrc.js
├── .gitignore
├── babel.config.js
├── jest.config.js
├── LICENSE
├── yarn.lock
├── package.json
└── 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. tests: This directory will contain all of unit test files for your project.

6. .browserslistrc: This file will contain the information regarding which browsers will be supported when the application is built.

7. .eslintrc.js: This file contains the linting configuration for eslint.

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

9. .babel.config.js: This file tells babel how to transpile the application's code.

10. jest.config.js: This is a configuration file for Jest.

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

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

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

Learning Storybook

1. Read the official StoryBook docs
2. Learn about Design Systems for Developers in this official Storybook tutorial.

Publish to NPM

• download npmrc npm install -g npmrc
• log in to the mindedge npm account via terminal, login details on lastpass shared tech folder npmrc mind-edge
• cd into the laika folder
• Run npm publish