Skip to content

chrisbertrandsagecom/carbon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Carbon Codeship Status Travis Status npm

Carbon is a library of reusable React components.

See the demo and documentation site for live examples, or see create-carbon-app to get started.

Documentation

Getting Started

Guides

Testing

As Carbon is just React components, we support any test suite you prefer to use. However we also provide out-of-the-box test tooling through Carbon Factory.

Running the Demo Site Locally

  1. Clone the carbon repository (git clone [email protected]:Sage/carbon.git)
  2. cd carbon
  3. npm install
  4. npm start
  5. Navigate to http://localhost:8095/ in your favourite browser

Note: MockAPI for tables and dropdowns is disabled locally as it conflicts with HotReloading. To enable see src/main.js file

Adding Release Notes

  • Use renogen, or add a yml file manually to ./changelog/next e.g. ./changelog/next/my-update.yml.
  • Update or add an appropriate heading in the style shown below for each change:
Bug Fixes: "Modal: The Modal is now centered in the browser."

Technologies

The following is a list of technologies Carbon utilises:

  • React (JSX) - Components are written using React, as well as the useful JSX syntax.
  • Immutable.js - For better performance and data handling, the components rely on using immutable data.
  • Node (CommonJS) - The components (or modules) are written using the CommonJS pattern. This allows for modularity and creating isolated/independent components.
  • Webpack - In order to consume the modular components in the browser, the code is compiled through Webpack. This also allows managing other dependencies such as stylesheets and images.
  • Babel (ES6) - To benefit from ES6 (and ES7) features, the code is compiled through Babel (this also compiles the JSX).

Browser Support

We support and test the Carbon Library against the latest versions of the following browsers:

Licence

Carbon is licensed under the Apache-2.0 licence.

Copyright (c) 2018 Sage Group Plc. All rights reserved.

About

Carbon by Sage | ReactJS UI Component Library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.3%
  • Gherkin 10.5%
  • CSS 2.1%
  • Other 0.1%