Getting Started

To run Outkit locally, you will first need to clone the repository using git:

git clone git@github.com:Outfitio/outkit.git

After that has finished cloning, you will need to cd into the new directory and install the project dependencies using yarn

cd outkit && yarn

It is import to always yarn and not npm. Yarn uses a yarn.lock to make sure there is an identifier for every dependency and sub dependency. By running npm install you will mess up the yarn.lock file.

---

Documentation website

To run the documentation website (this website you are currently viewing), run the following command:

yarn docs

You should now be able to view at website at localhost:3000.

---

Storybook

To run the storybook website locally, run the following command:

yarn storybook

You should now be able to view the storybook at localhost:3001

---

Playroom

To run the playroom website locally, run the following command:

yarn playroom

You should now be able to view the playroom at localhost:3002

---

Testing

To run all of the tests locally, run the following command:

yarn test

Formatting / linting

If you just want to check the formatting and linting of all files, you can run the following command:

yarn lint

If you just want to check the component tests, you can run the following command:

yarn test:components