Merge pull request #1 from Lightning-Flow-Scanner/v1-dev

init

Author: RubenHalman

README.md

@@ -1,23 +1,60 @@
-# Lightning Web Component - Development Preview
+ [![Lightning Flow Scanner](media/banner.png)](https://github.com/Lightning-Flow-Scanner)
+Pinpoint deviations from Industry Best Practices in Salesforce Flows and ensure standards of business automation excellence.
 
-**Note: This project is still in development.**
+ [![Demo](media/lfsapp.gif)](https://github.com/Lightning-Flow-Scanner)
 
-## Overview
+## Features
 
-This project aims to integrate a core module into a Lightning Web Component (LWC) in Salesforce. The core module is successfully being loaded as a static resource, although it seemingly required several changes on the core module. We are currently able to show the rules.
+- **Flow Overview**: Displays a list of all flows in your Salesforce org.
+- **Scan Flow**: Allows users to scan the metadata of a selected flow.
+- **Flow Analysis**: Provides detailed metadata analysis of the selected flow.
 
-## Core Module
+## Using the Lightning Flow Scanner
 
-The core module is loaded as a single JavaScript file static resource. The JavaScript file can be generated using `ncc` on the core module as follows:
+1) Open the App Launcher:
+- Click on the App Launcher icon in the top-left corner of your Salesforce interface.
+- Search for "Flow Scanner" in the App Launcher search bar.
+- Click on the "Flow Scanner" app to open it.
 
-`git clone https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core.git`
+2) Scan a Flow:
+- To scan a flow, click the "Scan" button next to the flow you want to analyze.
 
-`cd lightning-flow-scanner-core`
+## Project Structure
 
-`git checkout toolingapi`
+The project is organized into two main directories:
 
-`npx rollup -c rollup.config.js`
+1) force-app: The main application(tab, page etc)
+2) lfs_component: Contains the Lightning Flow Scanner Component, used by the main application.
 
-## Development Status
+This structure allows for clear separation of the core scanning functionality and the main application logic. By modularizing the core scanning functionality, we ensure easier maintenance and updates. Additionally, this setup encourages other Salesforce apps to integrate our functionality, promoting collaboration and expanding the potential use cases for the Lightning Flow Scanner.
 
-Despite the current state, this project demonstrates promising progress towards realizing a Lightning Web Component. 
+## Development
+
+### Development Flow
+
+1) Authorize Your Salesforce Org:
+Authorize your Salesforce org to set up a connection between your local development environment and the Salesforce org:
+
+```sh
+sfdx force:auth:web:login -d -a <YourOrgAlias>
+```
+
+2) Install dependency
+
+Install the Lightning Flow Scanner Component required for core functionality:
+
+```sh
+sfdx force:package:install --package 04tDn0000011NplIAE --wait 10 -u <YourOrgAlias>
+```
+
+3) Push Source to Your Org:
+Push the latest source to your og:
+
+```sh
+sfdx force:source:push
+```
+
+3) Pull Source from Your Org:
+```sh
+sfdx force:source:pull
+```

config/project-scratch-def.json

@@ -8,6 +8,11 @@
     },
     "mobileSettings": {
       "enableS1EncryptedStoragePref2": false
-    }
+    },
+    "securitySettings": {
+      "sessionSettings": {
+         "lockerServiceNext": true
+        }
+   }
   }
 }

force-app/main/default/applications/LFSApp.app-meta.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
+    <brand>
+        <headerColor>#203271</headerColor>
+        <logo>logo</logo>
+        <logoVersion>1</logoVersion>
+        <shouldOverrideOrgTheme>false</shouldOverrideOrgTheme>
+    </brand>
+    <description>Lightning Flow Scanner</description>
+    <formFactors>Small</formFactors>
+    <formFactors>Large</formFactors>
+    <isNavAutoTempTabsDisabled>true</isNavAutoTempTabsDisabled>
+    <isNavPersonalizationDisabled>true</isNavPersonalizationDisabled>
+    <label>Flow Scanner</label>
+    <navType>Standard</navType>
+    <tabs>Lightning_Flow_Scanner</tabs>
+    <uiType>Lightning</uiType>
+</CustomApplication>

force-app/main/default/aura/.eslintrc.json

@@ -0,0 +1,3 @@
+<aura:application access="GLOBAL" extends="ltng:outApp"> 
+    <aura:dependency resource="c:lightningFlowScannerApp" />
+</aura:application>	

force-app/main/default/aura/LFS_App/LFS_App.app

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<AuraDefinitionBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>58.0</apiVersion>
+    <description>A Lightning Application Bundle</description>
+</AuraDefinitionBundle>

force-app/main/default/aura/LFS_App/LFS_App.app-meta.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ContentAsset xmlns="http://soap.sforce.com/2006/04/metadata">
+    <isVisibleByExternalUsers>false</isVisibleByExternalUsers>
+    <language>en_US</language>
+    <masterLabel>logo</masterLabel>
+    <relationships>
+        <organization>
+            <access>VIEWER</access>
+        </organization>
+    </relationships>
+    <versions>
+        <version>
+            <number>1</number>
+            <pathOnClient>logo.png</pathOnClient>
+        </version>
+    </versions>
+</ContentAsset>