Giter Club home page Giter Club logo

infineon-design-system-bootstrap's Introduction

Infineon Design System Bootstrap Components

GitHub Repo Issues GitHub Pull Requests GitHub Repo Version GitHub Master Branch Weekly Commits GitHub Repo Contributors GitHub Repo Discussions

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Local Development
  5. Contact

About The Project

As part of the Infineon brand guidelines, the Infineon Digital Design System supports designers, developers and project managers to build user interfaces faster and better โ€“ with the ultimate goal to create a coherent and optimal user journey across all internal and external Infineon digital touchpoints.

This repository contains an Bootstrap implementation of Infineons Digital Design System and it's Storybook sourcecode.

Use it to build & run storybook and distribute the Bootstrap SCSS.

Built With

  • React
  • Bootstrap

back to top

Getting Started

Prerequisites

  • Node v14 or older.
  • Yarn v1.22.10 or older, or Npm v6.14.13 or older.

Installation on React, Vue or Angular

With NPM

  1. npm install --save @infineon/design-system-bootstrap

With Yarn

  1. yarn add @infineon/design-system-bootstrap

Add to main.js

import "@infineon/design-system-bootstrap";

Installation Fontawesome

  1. Send an email to [email protected] to get the fontawesome token key. Then execute these two commands:
npm config set "@fortawesome:registry" https://npm.fontawesome.com/
npm config set "//npm.fontawesome.com/:_authToken" <PASTE KEY HERE>

Additional Fontawesome installation instructions can be found here:

For Angular: https://fontawesome.com/v5/docs/web/use-with/angular
For Vue https://fontawesome.com/v6/docs/web/use-with/vue/
For React: https://fontawesome.com/v6/docs/web/use-with/react/

back to top

Usage

Explore our components in Storybook.

https://storybook-bootstrap.icp.infineon.com

back to top

Local Development

Installation

Install all the modules and dependencies listed on the package.json file with:

yarn install

or

npm install

Build Storybook

To deploy Storybook, we first need to export it as a static web app. To do so, we can use the inbuild build-storybook command with npm or yarn.

yarn build-storybook

or

npm build-storybook

This will generate a static Storybook in the storybook-static directory.

Start Storybook

To start storybook, simply run the inbuild command start-storybook with npm or yarn.

yarn start-storybook

or

npm start-storybook

start-storybook also executes watch-css and watch-storybook which automatically update storybook on code change.

back to top

Contact

WebEx

Yanchev Tihomir
Werther Kai

Email

[email protected]
[email protected]

back to top

infineon-design-system-bootstrap's People

Contributors

g-rdknt avatar hboifx avatar julrich avatar kaiwerther avatar nk-radikant avatar tishoyanchev avatar verena-ifx 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.