@themindfulpug/core

The Mindful Pug Web Storybook

The Mindful Pug web component library

Overview

This project hold all custom components made for The Mindful Pug. Here we can view, configure, and manage components so that our application projects are clean and consistent.

Development

We decided to use yarn instead of npm, which means you can run the commands below to get setup

Install your dependencies:

yarn

Setting up your environment

In the root directory there is a .env.template file that you can copy and rename .env. The .env file is ignored when committing to git so it is safe to keep secrets there. Speak with a lead to get appropriate values for your environment file.

Testing

It's a good idea to run the tests before you make any changes to validate that your environment is setup correctly. To do this, follow the steps below.

yarn test

Starting your dev server

yarn storybook

Deployment

Production

Every commit to the master branch will trigger a deployment automatically. As components are added they should show up in our component library as soon as possible.