The Equisoft design system.
This project is setup as a monorepo containing multiple packages. While closely related, every package in the /packages/ folder is stand-alone.
Packages meant for use within Equisoft apps are currently being published to Equisoft's NPM repository.
Please visit each package's README for installation and usage details.
To contribute to Design Elements or implement its components in your app, you will most likely have to get familiar with the following packages:
/react/: React implementation of Design Elements. This is our first delivery target./storybook/: This package contains the Storybook documentation for Design Elements' React components. This includes props documentation and components implementation examples.
Note to Windows users: If you have make installed, you can run it with make -f Makefile instead of make. If it doesn't work, your best bet is to look at the Makefile and run the commands separately
All the packages are linked together using yarn 2.
# Running stuff for dev, usually 1 per terminal. Watches files and rebuilds as needed.
make react
make storybook# Building for production
make build_react
make build_storybookDesign Elements is an Equisoft inner source project. As such, we welcome and encourage contributions to it from both product and service teams.
Here are the ways you are invited to contribute:
- Developing a new component
- Adding features to an existing component
- Bug fixing
We use issue and pull request templates to standardize the contribution process and improve communication in the repo.
When reporting a bug, requesting a feature or submitting a pull request, please take the time to fill all relevant fields.
This project is designed, coded and maintained by the interdisciplinary Product Design Team based in Equisoft's Quebec City and Montreal offices.