Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.63 KB

README.md

File metadata and controls

82 lines (52 loc) · 2.63 KB

npm version Build Status Coverage Status Slack

Description

The fundamental-react library is a set of React components built using SAP Fiori Fundamentals.

The SAP Fiori Fundamentals library is a design system and HTML/CSS component library used to build modern product user experiences with the SAP look and feel.

API Reference

See Component Documentation for examples and API details.

Requirements

You will need to install Node and Node Package Manager.

Getting Started

  1. Clone this repository to your local machine

    git clone https://github.com/SAP/fundamental-react.git
    
  2. Navigate to the directory

    cd fundamental-react
    
  3. Install dependencies

    npm install
    
  4. Run in development mode

    npm start
    

Open http://localhost:3000 to view it in the browser.

Testing

npm run test
npm run test:coverage

Linting

npm run lint

Versioning

The fundamental-react library follows Semantic Versioning. These components strictly adhere to the [MAJOR].[MINOR].[PATCH] numbering system (also known as [BREAKING].[FEATURE].[FIX]).

Merges to the master branch will be published as a prerelease. Prereleases will include an rc version (e.g. [MAJOR].[MINOR].[PATCH]-rc.[RC]).

Support

If you encounter an issue or want to request a feature, you can create an issue.

Contributing

If you want to contribute, please check the Contribution Guidelines.

License

Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This library is licensed under the Apache Software License, v. 2 except as noted otherwise in the License File.

Similar Projects