Skip to content
This repository was archived by the owner on Aug 25, 2025. It is now read-only.

Commit 8752abd

Browse files
committed
improve readme: flow deployment
1 parent e6ef177 commit 8752abd

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

readme.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -162,39 +162,39 @@ Specifying exceptions allows you to exclude specific scenarios from rule enforce
162162

163163
Follow these steps to set up your development environment:
164164

165-
0. **Deploy Flows(Optional):** test the rules against real flow metadata with a set of [example flows](./example-flows/force-app/main/default/flows) for demonstration purposes.
165+
1. **Clone Repository:** Begin by cloning the Lightning Flow Scanner Core repository to your local machine:
166166

167-
```bash
168-
npm run deploy:flows -- -o <your-org-alias>
169-
```
167+
```bash
168+
git clone https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core.git
169+
```
170170

171-
1. **Clone Repository**: Begin by cloning the Lightning Flow Scanner Core repository to your local machine:
171+
*(*Optional) Deploy Flows: test the rules against real flow metadata with a set of [example flows](./example-flows/force-app/main/default/flows) for demonstration purposes:\*
172172

173-
```bash
174-
git clone https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core.git
175-
```
173+
```
174+
npm run deploy:flows -- -o
175+
```
176176

177177
2. **Install Dependencies**: Navigate into the cloned repository directory and install the necessary dependencies using Yarn:
178178

179-
```bash
180-
cd lightning-flow-scanner-core
181-
npm install
182-
```
179+
```bash
180+
cd lightning-flow-scanner-core
181+
npm install
182+
```
183183

184-
3. **Build**: Compile the TypeScript source files into JavaScript using the TypeScript compiler:
184+
4. **Build**: Compile the TypeScript source files into JavaScript using the TypeScript compiler:
185185

186186
```bash
187187
npm run build
188188
```
189189

190190
This command generates the compiled JavaScript files in the `out` directory.
191191

192-
4. **Run Tests**: Ensure the module functions correctly by running the test suites:
192+
5. **Run Tests**: Ensure the module functions correctly by running the test suites:
193193

194194
```bash
195195
npm run test
196196
```
197197

198198
This command uses Mocha to run tests located in the `tests` directory and provides feedback on the module's functionality.
199199

200-
5. **Debugging in IDE**: If needed, set up your integrated development environment (IDE) for debugging TypeScript code. Configure breakpoints, inspect variables, and step through the code to identify and resolve issues efficiently.
200+
6. ~~**Debugging in IDE**: If needed, set up your integrated development environment (IDE) for debugging TypeScript code. Configure breakpoints, inspect variables, and step through the code to identify and resolve issues efficiently.~~

0 commit comments

Comments
 (0)