Code Monkey home page Code Monkey logo

canaille's Introduction

Canaille

Overview

Canaille is a design system created by Bdx.town for building our user interfaces. The system is composed of three libraries that work together to provide a seamless experience for developers and designers.

The first library is a SASS library that provides a comprehensive set of utility CSS classes. These classes can be used to quickly and easily style any element on a page. The classes are designed to be modular, so developers can mix and match them as needed to achieve their desired look and feel.

The second library is a React library that provides a collection of reusable UI components. These components are built using the design tokens from the SASS library, making it easy to create consistent and visually appealing interfaces. The React library includes everything from basic layout components to more complex interactive components like modals and dropdown menus.

The third library is a SVG library that exports a JavaScript bundle for icons. These icons can be easily included in any project that uses Canaille, and are designed to be flexible and scalable to fit any design.

Canaille (v3+) uses CSS layers to avoid messing with user's code. Utilities classes will take over components style, and other css code will win everything.

Live preview

You can go there to see Canaille at it current state: https://cl0v1s.github.io/Canaille

The current mockup can be found here

Technical stack

  • node
  • javascript
  • typescript
  • sass

Requirements

  • Node version 20+
  • Yarn

Code style

Please check .eslintrc file

Third-party libraries

Please check package.json for a comprehensive list of canaille dependencies.

react and react-dom, react-router-dom are exposed as externals of this project. Projects using Canaille must provide compatible versions.

Getting started

  1. yarn
  2. yarn laddle

Build project

  1. yarn
  2. yarn build-prod

canaille's People

Contributors

cl0v1s avatar

Watchers

 avatar Seth Pilgrim avatar

canaille's Issues

[DR] Block

Le composant Block (qui correspond dans tes maquettes à "Link preview" en moins spécialisé) est dispo

[DR] Buttons

Les boutons sont prêts pour une revue. Tu peux aller les voir sur ta machine et jouer avec. Pour ce qui concernent ceux avec des Icones dedans, c'est déjà ok, faut simplement que je code les icones, mais ça fait partie du contenu du bouton, pas de son apparence en général.

http://localhost:9005/Actions/Button/index.html

Je t'invite donc à me lister tes retours ci-dessous, ou carrément me filer du css !

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.