|
1 | 1 | <p align="center"> |
2 | 2 | <a href="https://github.com/Flow-Scanner"> |
3 | | - <img src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/media/bannerslim.png" style="width: 55%;" /> |
| 3 | + <img src="media/banner.png" style="width: 41%;" /> |
4 | 4 | </a> |
5 | 5 | </p> |
6 | 6 | <p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p> |
7 | 7 |
|
8 | 8 | [](https://github.com/Lightning-Flow-Scanner) |
9 | 9 |
|
| 10 | +## Features |
| 11 | + |
| 12 | +**Lightning Flow Scanner App** integrates the Lightning Flow Scanner as a UMD module within Salesforce, enabling scanning of flow metadata. The app runs predefined rules and presents detailed scan results for flows, including violation details, severity levels, and relevant flow metadata. |
| 13 | + |
10 | 14 | ## Installation |
11 | 15 |
|
12 | 16 | <a href="https://githubsfdeploy.herokuapp.com?owner=Flow-Scanner&repo=lightning-flow-scanner-app&ref=main"> |
13 | 17 | <img alt="Deploy to Salesforce" |
14 | 18 | src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png"> |
15 | 19 | </a> |
16 | 20 |
|
17 | | -## Using the Flow Scanner |
18 | | - |
19 | | -1) Open the App Launcher: |
20 | | -- Click on the App Launcher icon in the top-left corner of your Salesforce interface. |
21 | | -- Search for "Flow Scanner" in the App Launcher search bar. |
22 | | -- Click on the "Flow Scanner" app to open it. |
| 21 | +## Usage |
23 | 22 |
|
24 | | -2) Scan a Flow: |
25 | | -- To scan a flow, click the "Scan" button next to the flow you want to analyze. |
| 23 | +1) Assign the `LFSApp` permission set, to any user that requires access to the flow scanning abilities. |
| 24 | +2) Open the App: |
| 25 | + - Click on the App Launcher icon in the top-left corner of your Salesforce interface. |
| 26 | + - Search for "Flow Scanner" in the App Launcher search bar. |
| 27 | + - Click on the "Flow Scanner" app to open it. |
| 28 | +3) To scan a flow, click the "Scan" button in the Flow Overview. |
26 | 29 |
|
27 | 30 | ## Development |
28 | 31 |
|
29 | | -### Development Flow |
30 | | - |
31 | | -1) Authorize Your Salesforce Org: |
32 | | -Authorize your Salesforce org to set up a connection between your local development environment and the Salesforce org: |
| 32 | +1) Clone this repository: |
33 | 33 |
|
34 | 34 | ```sh |
35 | | -sfdx force:auth:web:login -d -a <YourOrgAlias> |
| 35 | +git clone https://github.com/Flow-Scanner/lightning-flow-scanner-app.git |
36 | 36 | ``` |
37 | 37 |
|
38 | | -2) Install dependency |
39 | | - |
40 | | -Install the Lightning Flow Scanner Component required for core functionality: |
| 38 | +2) Authorize your Salesforce org to set up a connection with your local development environment: |
41 | 39 |
|
42 | 40 | ```sh |
43 | | -sfdx force:package:install --package 04tDn0000011NpvIAE --wait 10 -u <YourOrgAlias> |
| 41 | +sf login web --set-default --alias <YourOrgAlias> |
44 | 42 | ``` |
45 | 43 |
|
46 | 44 | 3) Push Source to Your Org: |
47 | | -Push the latest source to your og: |
48 | 45 |
|
49 | 46 | ```sh |
50 | | -sfdx force:source:push |
| 47 | +sf project:deploy:start |
51 | 48 | ``` |
52 | 49 |
|
53 | | -3) Pull Source from Your Org: |
| 50 | +4) Pull Modifications from Your Org: |
| 51 | + |
54 | 52 | ```sh |
55 | | -sfdx force:source:pull |
| 53 | +sf project sync |
56 | 54 | ``` |
57 | 55 |
|
58 | | -If you'd like to help us enhance Flow Scanner, please consider having a look at the [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md). |
| 56 | +Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md). |
0 commit comments