Skip to content

Commit

Permalink
Merge pull request #783 from etn-ccis/feature/remove-blui-cli-references
Browse files Browse the repository at this point in the history
Review changes - Removed blui cli references
  • Loading branch information
surajeaton authored Dec 5, 2024
2 parents 51a27f6 + bbc6071 commit ab6a107
Show file tree
Hide file tree
Showing 5 changed files with 170 additions and 148 deletions.
2 changes: 1 addition & 1 deletion src/docs/development/frameworks-mobile/react-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You'll need to start by following the general instructions for setting up your d

## Using the Brightlayer UI CLI

The fastest way to start a new Brightlayer UI project is to use the [Brightlayer UI CLI](/development/cli). The CLI will automatically create a starter project for you using the [React Native Community CLI](https://github.com/react-native-community/cli) with all of the necessary Brightlayer UI dependencies pre-configured. To start a React Native project:
The fastest way to start a new Brightlayer UI project is to use our templates. The [React Native Community CLI](https://github.com/react-native-community/cli) will automatically scaffold a starter project for you using the Brightlayer UI templates with all of the necessary Brightlayer UI dependencies pre-configured. To start a React Native project:

```sh
npx react-native init MyApp
Expand Down
4 changes: 2 additions & 2 deletions src/docs/development/frameworks-web/angular.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import { Divider } from '../../../app/components';

## Using an Existing Project

If you have an existing project and would like to integrate Brightlayer UI, you can follow the manual integration instructions below. If you have not already started your project, we recommend that you scaffold your project with the Brightlayer UI CLI.
If you have an existing Angular project and would like to integrate Brightlayer UI, you can follow the manual integration instructions below.

<Divider />

# Manual Brightlayer UI Integration

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.

## Including the Component Libraries

Expand Down
6 changes: 3 additions & 3 deletions src/docs/development/frameworks-web/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following instructions will guide you through starting a new Brightlayer UI

## Using the Brightlayer UI Templates

The fastest way to start a new Brightlayer UI project is to use the [Brightlayer UI Templates](/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](/development/templates). The Brightlayer UI templates will automatically create a starter project for you using [Vite](https://vite.dev/guide/) to scaffold the project with all of the necessary Brightlayer UI dependencies pre-configured. To start a React project:

```sh
npx create-blui-react-app
Expand Down Expand Up @@ -40,13 +40,13 @@ For detailed usage instructions, refer to the [Brightlayer UI React Templates do

## Using an Existing Project

If you have an existing project and would like to integrate Brightlayer UI, you can follow the manual integration instructions below. If you have not already started your project, we recommend that you scaffold your project with the Brightlayer UI CLI.
If you have an existing project and would like to integrate Brightlayer UI, you can follow the manual integration instructions below. If you have not already started your project, we recommend that you scaffold your project with the Brightlayer UI Templates.

<Divider />

# Manual Brightlayer UI Integration

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
6 changes: 3 additions & 3 deletions src/docs/development/templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When starting a new project, you will have the opportunity to select a template

> These templates are available for [React](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/README.md#react-cli-templates), and [React-Native](https://github.com/etn-ccis/blui-react-native-cli-templates/blob/master/README.md#react-native-cli-templates).
To start a new project using the React Template:
To create a new project using the React Templates:

```sh
npx create-blui-react-app
Expand All @@ -27,7 +27,7 @@ npx create-blui-react-app
To create a new project using the React Native Template simply run:

```sh
npx react-native init MyApp
npx react-native init MyApp --template @brightlayer-ui/react-native-template-authentication-typescript
```

For more detailed information and usage instructions, check out the [React documentation](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/README.md) and [React Native documentation](https://github.com/etn-ccis/blui-react-native-cli-templates/blob/master/README.md).
For more detailed information, templates and usage instructions, check out the [React documentation](https://github.com/etn-ccis/blui-react-cli-templates/blob/master/README.md) and [React Native documentation](https://github.com/etn-ccis/blui-react-native-cli-templates/blob/master/README.md).
Loading

0 comments on commit ab6a107

Please sign in to comment.