@salo/elements NPM

Elements

The elements library is designed to work with the Salo Creative Next.js application structure. As far as possible it is decoupled from next. However, in Auth and Apollo areas it does rely on environment variables from Next to work. The rest of the library should be suitable for use with any react application.

Auth

As part of this restructure, the auth library and helpers are now centralised to this library. Full documentation can be found within the storybook for the UI library.

UI library

The core of this repo is the UI library for all Salo Creative applications. This ui library is essentially an upgraded and modernised version of salo-creative/core-ui. To assist with the development the UI library utilises storybook so changes can be made in this library without having to sync it to the main applications.

Development

To get started run the following command to install the dependencies and start storybook for development. All components should be built along atomic design principles and documented thoroughly. Please remember all components will be used across a wide range of applications so they should be built with theming and customisation in mind. Any organisms such as messaging or comment systems should allow custom molecules to be passed if required. Reference the dynamic form component as a guide

yarn && yarn storybook

Publishing

All the elements of this library are published simultaneously via the following process.

Create a feature branch from master
Open a PR from your feature back to master. This can be repeated multiple times between release
For each change update the draft release on github to maintain an accurate changelog
When you are ready to release the library checkout master increment the package.json and push back to origin
On github publish the draft release, ensuring the tag matches the package.json version number. When you publish the tag the CI should kick in and automatically publish for you