Giter VIP home page Giter VIP logo

ce-design-system's Introduction

CIRCLE ECONOMY DESIGN SYSTEM

  1. CEDS is a design system package made for Circle Economy projects. We utilize this package to share application logic between other projects.

  2. 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.

Development

  1. Clone the repo:

    git clone https://gitlab.com/circleeconomy/honey-jungle/front-end/ceds.git
    cd ceds
  2. Make sure you are using node version 16.4.1

Deployment

  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

  2. On the External project repo, update the version for CEDS in the package.json, run npm run install and then commit the package update.

Usage

npm install @circleeconomy/ceds
import { Icon } from '@circleeconomy/ceds';
ReactDOM.render(<Icon name='search' />, mountNode);

ce-design-system's People

Watchers

odiso avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.