Git Product home page Git Product logo

design-system's Introduction

Strapi logo

Documentation|Try components


NPM Version Bundle Size Playwright tests Strapi on Discord

Welcome! ๐Ÿ‘‹๐Ÿ‘‹๐Ÿ‘‹

Strapi Design System provides guidelines and tools to help anyone make Strapi's contributions more cohesive and to build plugins more efficiently.

Installation

Install Strapi Design System and its peer dependencies:

$ yarn add @strapi/design-system @strapi/icons styled-components

# or

$ npm i @strapi/design-system @strapi/icons styled-components

Usage

Wrap your application with the ThemeProvider and pass the default lightTheme provided by @strapi/design-system.

import { ThemeProvider } from "@strapi/design-system/ThemeProvider";
import { lightTheme } from "@strapi/design-system/themes";

function App({ children }) {
  return <ThemeProvider theme={lightTheme}>{children}</ThemeProvider>;
}

export default App;

Testing a specific branch

Make sure to have the project already cloned (see previous point). Then, run the following commands:

# Inside the folder
$ git checkout BRANCH_NAME # BRANCH_NAME concerns the modifications to tests
$ yarn setup # reinstall dependencies & prepare lerna packages

If you encounter problems doing so, run the following command and retry the previous one:

$ git reset --hard

design-system's People

Contributors

hichamelbsi avatar ronronscelestes avatar gu-stav avatar soupette avatar bassel17 avatar smontlouis avatar specifyapp[bot] avatar oiorain avatar dependabot[bot] avatar philippkhon avatar maevalienard avatar zoha avatar mattiebelt avatar imklau avatar richorrichard avatar remidej avatar artkondakov avatar kibblerz avatar handu avatar fdel-car avatar mfrachet avatar pritamsanganitw avatar ivanthepleasant avatar

Stargazers

Augustin MBARGA 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.