(c) 2019-2022 GoodData Corporation This repository is under the BSD-3-clause license available in the LICENSE file and includes additional third party packages under separate open source licenses as specified in the NOTICES file.
GoodData Create React App
This is a CLI tool that creates a new React project with a proxy set up to connect to your projects on the GoodData platform. The new app features some widgets and helpers that could come in handy. The app is built on top of Create React App. For more info see Create React App documentation.
How to use
To create a project called
my-app, run this in your terminal:
npx @gooddata/create-gooddata-react-app my-app
Then follow the instructions provided by the CLI.
When navigating to your application using an IP address instead of localhost, you may run into
401 errors while trying to log in. This is due to proxying and cookie rewriting rules that the generated application uses to get around CORS. Use localhost instead of IP addresses to access the application because the development server rewrites GDC cookies to be for localhost.
NOTE: We use
yarn dependency manager. To install it, follow its documentation. If you don't want to use
yarn, provide the
--no-install flag like
npx @gooddata/create-gooddata-react-app my-app --no-install . This will skip calling
yarn install and you will have to manually install the dependencies of the created app. Please note that we do not provide
package-lock.json so the application may not work properly when dependencies are installed using
@gooddata/create-gooddata-react-app supports several optional flags:
--hostname <hostname>URL of your GoodData host
-c, --config <config>path to configuration file (see below)
--no-installskip yarn installing the app dependencies
--verboseoutput additional logs, useful mainly for debugging and bug reports
-h, --helpoutput usage information
--backend <backend>switch backend to a desired one (default:
--flavor <flavor>desired flavor of the application:
The configuration file has the following structure:
@gooddata/create-gooddata-react-app, please make sure that you have all compatible technologies installed on your device.
In case there are errors while running
@gooddata/create-gooddata-react-app, please try these steps.
Remove older versions
Sometimes having older versions of
@gooddata/create-gooddata-react-app can cause errors. In that case please remove any previously installed versions by running
npm uninstall -g @gooddata/create-gooddata-react-app yarn global remove @gooddata/create-gooddata-react-app
Force npx to use the latest version
You can force
npx to use latest version of the tool by appending the
@latest to the
npx @gooddata/create-gooddata-react-app@latest my-app
Enable verbose output
You can increase the logging level of
@gooddata/create-gooddata-react-app my-app by providing the
--verbose flag like
npx @gooddata/create-gooddata-react-app my-app --verbose
Internet Explorer 11 is no longer supported.