GS UI Boilerplate

This is a boilerplate generator for GS UI applications. It provides a ready-to-use setup with React, TypeScript, and GS UI components.

Installation

You can create a new application using this boilerplate by running:

npx create-gs-ui-boilerplate-app my-app-name
cd my-app-name
yarn start

Publishing

To publish updates to this boilerplate:

1. Make your changes to the template
2. Update the version in package.json
3. Run npm login (if not already logged in)
4. Run npm publish

After publishing, users can create new applications using the updated template with npx create-gs-ui-boilerplate-app.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Available Routes

The application provides the following routes:

• /hello: Displays the HelloWorld component, a simple component to verify the setup.
• /productTable: Displays the ProductTable component from @gs/react-ui, showcasing the UI components available in the library.
• /chart: Displays the Chart component from @gs/crystalball-ui, demonstrating the charting capabilities of the Crystalball UI library.

To access these routes, run the application and navigate to the desired path in your browser.