-
CEDS is a design system package made for Circle Economy projects. We utilize this package to share application logic between other projects.
-
Branch Management Strategy on GitLab repo:
- main
- The main branch should be aligned with the production environment, we usually merged into main immediately before a production deploy.
- dev
- The dev branch should be branched off of for new feature requests and bugfixes.
- We try to follow the conventional commits specification for branch naming (ie, feat/fix).
- sprint[tag][1]
- When working on larger features we utilize the sprint branch instead of development, this helps to free up the development branch for smaller tasks that may come through in the meantime.
- main
-
Clone the repo:
git clone https://gitlab.com/circleeconomy/honey-jungle/front-end/ceds.git cd ceds
-
Make sure you are using node version
16.4.1
-
After making changes and changing the package.json version, first commit your work. When are you ready to push the update to GitLab run
npm run build
&npm run publish
-
On the External project repo, update the version for CEDS in the package.json, run
npm run install
and then commit the package update.
npm install @circleeconomy/ceds
import { Icon } from '@circleeconomy/ceds';
ReactDOM.render(<Icon name='search' />, mountNode);