Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed bli cli and its references #923

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Removed bli cli and its references #923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/src/__configuration__/listOfAllBluiReactPackages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ export const listOfAllBluiReactPackages = [
'@brightlayer-ui/react-auth-workflow',
'@brightlayer-ui/eslint-config',
'@brightlayer-ui/prettier-config',
'@brightlayer-ui/cli',
'@brightlayer-ui/cra-template-authentication-typescript',
'@brightlayer-ui/cra-template-routing-typescript',
'@brightlayer-ui/cra-template-blank-typescript',
Expand Down
10 changes: 5 additions & 5 deletions docs/src/markdownDocs/gettingStarted/react.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import { CodeBlock } from '../../shared';

The following instructions will guide you through starting a new Brightlayer UI project using React. Alternatively, you can also start your project by downloading one of our code samples from [Github](https://github.com/etn-ccis?q=blui) (the Login or Navigation examples are good projects to start from).

# Generating a New Project with the Brightlayer UI CLI
# Generating a New Project with the Brightlayer UI React Templates

The fastest way to start a new Brightlayer UI project is to use the [Brightlayer UI CLI](https://brightlayer-ui.github.io/development/cli). The CLI will automatically create a starter project for you (using [Create React App](https://github.com/facebookincubator/create-react-app)) with all of the necessary Brightlayer UI dependencies pre-configured. To start a React project:
The fastest way to start a new Brightlayer UI project is to use the [Brightlayer UI Templates](https://brightlayer-ui.github.io/development/templates). This will automatically create a starter project for you (using [Create React App](https://github.com/facebookincubator/create-react-app)) with all of the necessary Brightlayer UI dependencies pre-configured. To start a React project:

<CodeBlock code={`npx -p @brightlayer-ui/cli blui new react`} language={'sh'} />
<CodeBlock code={`npx create-blui-react-app`} language={'sh'} />

You will be asked to provide a name for your project and whether you want to use the Brightlayer UI eslint and prettier configuration files.

Expand All @@ -26,13 +26,13 @@ The Brightlayer UI CLI will automatically include:
- Open Sans web font ([@fontsource/open-sans](https://www.npmjs.com/package/@fontsource/open-sans))
- Brightlayer UI ESLint and Prettier configurations, if selected ([@brightlayer-ui/eslint-config](https://www.npmjs.com/package/@brightlayer-ui/eslint-config) / [@brightlayer-ui/prettier-config](https://www.npmjs.com/package/@brightlayer-ui/prettier-config))

For detailed usage instructions, refer to the [Brightlayer UI CLI documentation](https://www.npmjs.com/package/@brightlayer-ui/cli).
For detailed usage instructions, refer to the [Brightlayer UI Templates documentation](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/README.md).

<Divider />

# Integrating Brightlayer UI into an Existing Project

Before taking the following steps, you'll want to make sure that you have an existing application. If you used the Brightlayer UI CLI to start your project, these steps have already been done for you automatically.
Before taking the following steps, you'll want to make sure that you have an existing application. If you used the Brightlayer UI Templates to start your project, these steps have already been done for you automatically.

## Including the Component Libraries

Expand Down
2 changes: 1 addition & 1 deletion docs/src/markdownDocs/themes/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You are also encouraged to explore our more detailed [example / showcase project

## For New Projects

We encourage you to use [Brightlayer UI CLI](https://brightlayer-ui.github.io/development/cli) to generate a new project. The CLI is a tool that can generate a bare bones React project that includes all essential Brightlayer UI packages, including the Brightlayer UI themes.
We encourage you to use [Brightlayer UI CLI](https://brightlayer-ui.github.io/development/templates) to generate a new project. The CLI is a tool that can generate a bare bones React project that includes all essential Brightlayer UI packages, including the Brightlayer UI themes.

## For Existing Projects

Expand Down
Loading