# create-blui-react-app

> This repository holds the different react vite templates used by Brightlayer UI

Latest version **2.0.2** (published 2025-12-18) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install create-blui-react-app
pnpm add create-blui-react-app
yarn add create-blui-react-app
bun add create-blui-react-app
```

Provides the command `create-blui-react-app`.

## Health

**Score 55/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2025-12-18 |
| First published | 2024-09-20 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20 |
| Dependencies | 2 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | brightlayerui |
| Keywords | template, brightlayer-ui, brightlayer ui, React, Vite, Typescript, Templates, React test library, Prettier, ESlint |

## Links

- npm: https://www.npmjs.com/package/create-blui-react-app
- Repository: https://github.com/etn-ccis/blui-react.git#dev
- Homepage: https://github.com/etn-ccis/blui-react/tree/dev#readme
- Issues: https://github.com/etn-ccis/blui-react/issues?q=is%3Aissue%20state%3Aopen%20label%3Acli-templates
- npm.io page: https://npm.io/package/create-blui-react-app

## Dependencies (2)

- [inquirer](https://npm.io/package/inquirer.md) ^12.6.0
- [typescript](https://npm.io/package/typescript.md) ^5.5.3

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2025-12-18
- 2.0.3-alpha.0 (alpha) — 2026-09-24
- 2.0.1 — 2025-09-11
- 2.0.0 — 2025-07-28
- 2.0.0-alpha.1 — 2025-07-24
- 2.0.0-alpha.0 — 2025-07-24
- 1.0.0 — 2024-12-30
- 1.0.0-alpha.2 — 2024-12-13
- 1.0.0-alpha.1 — 2024-09-20
- 1.0.0-alpha.0 — 2024-09-20

## README

[![Build](https://github.com/etn-ccis/blui-react-cli-templates/actions/workflows/blui-ci.yml/badge.svg?branch=master)](https://github.com/etn-ccis/blui-react-cli-templates/actions/workflows/blui-ci.yml)

# React + TypeScript + Vite Templates

These are project templates that are used for starting a new Brightlayer UI project. The templates are configured with the basic Brightlayer UI libraries for themes and components and configures the application to use them.

## Available Templates

### Blank

The [Blank template](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/templates/blank-typescript/README.md) provides a bare-bones application with Brightlayer UI components and themes automatically configured and ready to use.

### Routing

The [Routing template](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/templates/routing-typescript/README.md) provides all of the essential Brightlayer UI configuration as well as additional configuration for using using [React Router](https://reactrouter.com/). It also adds a navigation Drawer to switch between several sample screens.

### Authentication

The [Authentication template](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/templates/authentication-typescript/README.md) includes everything from the Routing template and also installs and configures the Brightlayer UI [react-auth-workflow](https://www.npmjs.com/package/@brightlayer-ui/react-auth-workflow) package to automatically wrap the main application with functions and screens for Okta Login, Registration, Change Password, etc.

|                | placeholder landing page | navigation drawer & routing | login & registration screens |
| -------------- | ------------------------ | --------------------------- | ---------------------------- |
| Blank          | ✅                       |                             |                              |
| Routing        | ✅                       | ✅                          |                              |
| Authentication | ✅                       | ✅                          | ✅                           |

## Screenshots

##### Routing Template With Collapsed Drawer

![Routing Template With Collapsed Drawer](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/images/routing.png)

##### Routing Template With Expanded Drawer

![Routing Template With Expanded Drawer](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/images/routing-expanded.png)

##### Login Screen from Auth Template

![Authentication Template Login](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/images/authentication.png)

## Usage

You can use these templates with the `create-blui-react-app` package:

```sh
npx create-blui-react-app
```

## Testing Locally

If you would like to test these templates locally, you may do so by running the following command:

```
npm link
npx create-blui-react-app
```

## Browser Support

Brightlayer UI CLI Templates will work with any modern browser. For details refer to our [Browser Support](https://brightlayer-ui.github.io/development/frameworks-web/react#browser-support) documentation.

---
_Source: https://npm.io/package/create-blui-react-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._