Getting started

Quick start guide

1. Clone the git repository
2. npm install
3. git checkout staging
4. git branch your-new-branch && git checkout your-new-branch
5. npm start
6. Commit your changes and submit a pull request to staging
7. When staging is ready for a new release, update CHANGELOG and run npm version <major|minor|patch>
8. Submit a pull request to merge staging to master
9. Pull updated master branch and run npm publish

Detailed guide

Installing

To get started clone the project to your development machine and run install dependencies with npm install.

We recommend using NodeJS version 10.15.3 LTS or greater.

Windows user? We have tried to update the development environment to also work on Windows. If you still run to issues it might be easier to get up and running using Docker. We have provided a basic docker-compose configuration for running the development environment using docker-compose up.

Running the development server

After installing dependencies run npm start to start your development server. If you make changes to styleguidist configuration or tokens, you might need to restart the process.

You can test building the package using npm run build

Git Workflow

We have two main remote branches:

1. Staging Development and testing branch for the components or changes that are going to be included in the next release. When developing you should base your development branch on staging.

   Push will trigger documentation website update which is available by link: https://staging-storaenso-ds.netlify.com/.

2. Master Release branch. Direct pushes to the master branch are blocked by BitBucket. To get your changes merged to production you need to first merge them to staging and submit a pull request. The latest documentation website for the production package available here: https://storaenso-ds.netlify.com/

Misc

Adding new documentation pages

Documentation files can be found under src/styleguidist/docs. To create a new page first create a new markdown file under the documentation folder and add a new section to styleguide.config.js.

Hotjar code

To get Hotjar tracking working, add SEEDS_DOCS_HOTJAR environment variable. Hotjar script is initialised when this variable is present, this functionality is implemented in styleguide.config.js.