Code Monkey home page Code Monkey logo

canada-design-system's Introduction

Canada πŸ‡¨πŸ‡¦

Canada is the Louffee's Design System intended to make beautiful UIs with a lot of UX touches 🧭.

A Design System is a collection of components that can be used to build UIs, following determined principles and styles, which are technically named tokens, and are also applied from design to code.

Overview

Inside the folder packages, the Design System is divided into several folders, each one containing one component or purpose.

Inside the same folder also can be found the variables and mixins files, which are used to define the tokens. As well as the global dev environment packages, such as the configurations for ESLint, Prettier and StyleLint.

Our status βš™οΈ

Environment Latest Status
Production Publish Production-Ready
Release Candidate Publish Release Candidate

Influences

Sure we don’t know everything, also we’re not trying to reinvent the wheel, so surely we have some influences that can be found in the hyperlinks below.

Naming

We know that naming stuff is the hardest thing on earth for developers, so we decided to use a naming convention to make it easier for us.

To the folders inside the component packages folder, we decided to use the following naming convention:

  • packages/@louffee-{component_name}

For global dev environment packages, we decided to use the following naming convention:

  • packages/@louffee-{config_original_3rd_package_name}-config

  • If the original 3rd party package name contains the namespace @ (for example: @namespace/package-name), we follow up the naming convention found in the @types namespace.

    • For example: @types/namespace__package-name.

For packages related to systems like a system for defining style, we add a -system suffix to the package name.

  • For example: packages/@louffee-{component_name}-system

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.