The Official starter template for GBG Apps for use with Create React App.
To use this template, add
--template @gbg/gbg when creating a new app.
npx create-react-app my-app --template @gbg/gbg # or yarn create react-app my-app --template @gbg/gbg
For more information on create react app, please refer to:
- Getting Started – How to create a new app.
- User Guide – How to develop apps bootstrapped with Create React App.
For more information on the GBG design system refer to:
node v12 is required to develop in this repository
Setting up your environment
First ensure you have cloned this repository and installed the requirements using
npm ci in your terminal.
CRA templates are pretty simple, just copying the template folder out and installing the stated components, to develop you can run the template from a local file address like this:
npx create-react-app my-app --template file:../cra-template-gbg
Submitting your changes
When you are ready to contribute your changes, ensure that you have a clear, clean branch containing only the changes you wish to contribute, push this branch and Raise a PR.
Raising a PR
Ensure that your PR includes the following
- A clear title.
- What is your PR doing.
- A clear description of the problem you are trying to solve.
- Any notes to help the reviewer.