Giter VIP home page Giter VIP logo

ciscouikit's Introduction

Cisco UI kit

The Cisco UI kit and pattern library is a style guide governing HTML markup at the presentation layer. It contains no javascript components. Instead, it focuses on HTML and CSS and leaves the choice of javascript toolkit up to the individual development teams.

This library is a collaboration between Cisco Brand and Cisco Engineering

Copyright and License

Code and documentation copyright 2019 Cisco Systems.


Building the UI Kit

Before you can build the UI Kit you will need to install a few tools.

1. Node - Download the latest (at least 5.11) version for your platform here

2. Git - Download the latest (at least 2.5.x) client here

3. Next install gulp via the node package manager (npm). You may need root access on your box to run this command.

$ npm install --global gulp-cli

NOTE: If you are using Windows 10 make sure to grab gitbash here

4.1 There are several ways to get the source. Create a folder and clone the UI Kit source from Github like this:

$ mkdir cui
$ cd cui
$ git clone https://github.com/CiscoDevNet/CiscoUIKit.git .

NOTE: You will want to work on a feature branch (not master!). To create a feature branch called foo run this:

$ git checkout -b foo origin/master

4.2 Or you can fetch the UI Kit source from Git via NPM like this:

in your package.json file add this line to the dependencies section:

"cisco-ui": "git+https://github.com/CiscoDevNet/CiscoUIKit.git"

or from your command-line run:

npm install git+https://github.com/CiscoDevNet/CiscoUIKit.git --save

4.3 Or you can fetch the UI Kit source from Git via Bower like this:

in your bower.json file add this line to the dependencies section:

"cisco-ui": "https://github.com/CiscoDevNet/CiscoUIKit.git"

4.4 Or you can fetch the UI Kit source from Git via Yarn like this:

From the command-line run:

yarn add git+https://github.com/CiscoDevNet/CiscoUIKit.git

NOTE: We use a common naming syntax like this v.{version}-official

5. Install the node modules

$ npm install

6. Build the UI Kit

$ npm run build

7. Open the UI Kit in your browser. In your browser of choice select File -> Open and choose build/docs/index.html

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.