This repo has been archived and moved here.
These are project templates that are used by Create React App when starting a new Brightlayer UI project. They are used behind the scenes by the Brightlayer UI CLI.
The Blank template provides a bare-bones application with Brightlayer UI components and themes automatically configured and ready to use.
The Routing template provides all of the essential Brightlayer UI configuration as well as additional configuration for using using React Router. It also adds a navigation Drawer to switch between several sample screens.
The Authentication template includes everything from the Routing template and also installs and configures the Brightlayer UI react-auth-workflow package to automatically wrap the main application with functions and screens for Login, Registration, Change Password, etc.
| placeholder landing page | navigation drawer & routing | login & registration screens | |
|---|---|---|---|
| Blank | ✅ | ||
| Routing | ✅ | ✅ | |
| Authentication | ✅ | ✅ | ✅ |
You can use these templates with the Brightlayer UI CLI (recommended):
npx -p @brightlayer-ui/cli blui new react --template=blank-typescript
npx -p @brightlayer-ui/cli blui new react --template=routing-typescript
npx -p @brightlayer-ui/cli blui new react --template=authentication-typescriptor with the Create React App CLI:
npx create-react-app app-name --template @brightlayer-ui/blank-typescript
npx create-react-app app-name --template @brightlayer-ui/routing-typescript
npx create-react-app app-name --template @brightlayer-ui/authentication-typescriptIf you would like to test these templates locally, you may do so by running the following command:
npx create-react-app myapp --template file:../path/to/template
For more information refer to the CRA documentation.
Brightlayer UI CLI Templates will work with any modern browser. For details refer to our Browser Support documentation.