pollux-web v0.0.1

Introduction

Pricemoov Design System is the framework that helps our ecosystem to design and develop consistent and quality experiences. For its Digital section, it is called POLLUX.

This repository hosts libraries for web applications.

Packages

In order to allow you to consume the elements of the Design System according to your product constraints, we give you the possibility of using the Pollux web libraries with different technologies & levels of granularity.

Global CSS styles 🎨

This package provides you with a complete CSS with a huge set of utility classes as it is generated with Tailwind CSS. Then it will be up to you to optimize for production by purging the CSS according to the classes used in your HTML:

Specific CSS styles 🖌

These packages allow the consumption of elements with a higher level of granularity. You get only the styles you need and what you consume is Pure CSS without CSS Custom Properties, therefore IE 11 compatible:

For design tokens

For each component (@pricemoov/pollux-css-*)

For utilities

Icons ✨

This package provides you with a library of SVG icons that you can include in a handful of ways (SVGs, icon font, sprite, CSS, embedded):

React

This package provides you with a library of React components:

Contributing

One of the Pricemoov Design System goals is to provide guidelines & components to gain in consistency, efficiency & accessibility. The best way to achieve this is together! We would love contributions (bug reports, feature requests, suggestions, Pull Requests, whatever you want!).

Yarn workspaces are used to manage dependencies and build config across package and lerna is used to manage versioning & publishing.

Run the following to setup your local dev environment:

# Install `yarn`, alternatives at https://yarnpkg.com/en/docs/install
brew install yarn

# Clone or fork `pollux-web`
git clone git@github.com:pricemoov/pollux-web.git # or your fork
cd pollux-web

# install dependencies
yarn

# start all showcases and build sources in watch mode & hot reload
yarn start
# or if you need don't need to launch every packages, you can launch separately:
yarn start:css
yarn start:icons
yarn start:react

# build packages
yarn build

# test packages
yarn test

👉 See the contributing docs for more information about how to contribute.