Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.19 KB

README.md

File metadata and controls

53 lines (36 loc) · 2.19 KB
Raw

GoodData.UI SDK

Getting Started

The easiest way to start developing analytical applications using GoodData.UI SDK is to use the Accelerator Toolkit. You will be up and running in minutes.

For detailed description of available components and capabilities see the official documentation.

You can also view our live examples or start the live examples application locally.

Contributing

Getting started

  1. Install nvm; for instance: curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

  2. Clone and bootstrap

    git clone [email protected]:gooddata/gooddata-ui-sdk.git
cd gooddata-ui-sdk
nvm install
nvm use
npm i -g @microsoft/rush
rush install

  3. Build: rush build

  4. Read the contribution guide

HINT: The repository includes the .envrc configuration file for direnv; you can use this to auto-nvm-use the correct node.js installation every time you enter the gooddata-ui-sdk directory.

After you pull latest changes

Always run rush install; this will make sure all the dependencies from the lock file will be installed in all the projects managed in the repository. After that run rush build.

In case the pull brings in new projects or large bulk of changes, it is safer (albeit more time-consuming) to run rush install && rush link --force && rush clean && rush rebuild.

You can find more technical information in contributor manual and in developer guide.

License

(c) 2017-2022 GoodData Corporation

This repository is under a GoodData commercial license available in the LICENSE file because it contains a commercial package, HighCharts. Subdirectories containing the MIT license are not subject to the GoodData commercial license and do not contain any commercial code. Please see the NOTICE file for additional licensing information related to this project's third-party open source components.