Skip to content

Commit

Permalink
docs: refresh does with salesforce info
Browse files Browse the repository at this point in the history
  • Loading branch information
stdavis committed Mar 28, 2024
1 parent 01b4292 commit 31dffb1
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 6 deletions.
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"salesforce.salesforcedx-vscode-expanded",
"salesforce.salesforcedx-vscode-core",
"salesforce.salesforcedx-vscode"
]
}
53 changes: 47 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,51 @@
deq-spills
==========
# DEQ Spills Web Application & Salesforce Integration

Web mapping application that is embedded into the DEQ Spills Salesforce application via a Lightning Component and an iframe.
This projects consists of two parts:

See [src/index.html](src/index.html) for an example of how to embed this widget and get data from it.
- Firebase web mapping application
- Salesforce Lightning Component

*Note: For development on `localhost` you may define the following global variable and pass a wide-open quad word: `AGRC_testQuadWord`.
## Firebase

DEQ Spills App Sandbox: https://utahdeqorg--eid.sandbox.my.salesforce.com/
This web site is embedded via iframe in several DEQ web applications. See [src/index.html](src/index.html) for an example of how this is done.

## Salesforce

This project also contains a Salesforce Lightning Component ([/salesforce](/salesforce/)) that embeds the Firebase web application via iframe in a similar way to other DEQ web applications.

Development Sandbox: <https://utahdeqorg--eid.sandbox.my.salesforce.com/>

Production Salesforce Instance: <https://utahdeqorg.lightning.force.com/>

## Development

>[!NOTE]
>For DEQ web developers developing on `localhost`: You need to define the following global variable and pass a wide-open quad word: `AGRC_testQuadWord`.
### Firebase

Pushes to `dev` and `main` branches will automatically deploy to staging and production Firebase instance respectively using the standard UGRC release and deploy actions.

### Salesforce

The Salesforce Lightning Component is developed in the `/salesforce` directory. The component is built using the [Salesforce Lightning Web Components](https://developer.salesforce.com/docs/component-library/documentation/en/lwc) framework.

#### Setup

1. Install the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli)
1. Authenticate with the DEQ Salesforce org: `sfdx org login web --instance-url https://utahdeqorg--eid.sandbox.my.salesforce.com/ --alias spillsSandbox`
1. Right-click on `manifest/package.xml` and select `SFDX: Retrieve Source in Manifest from Org`

#### Deploy To Sandbox

1. Right-click on `lwc` folder and select `SFDX: Deploy Source to Org`
1. Go to a case record in the sandbox (e.g. <https://utahdeqorg--eid.sandbox.lightning.force.com/lightning/r/Case/5003R000007Vao4QAC/view>)
1. Click the gear icon in the upper right corner and select `Edit Page`
1. Click on the "Save" button and then go back to the page (this is a hack to make sure that salesforce gets your changes).

#### Deploy To Production

1. Setup Cog button -> Setup
1. Quick Find -> Outbound Change Sets
1. Create a new set and add the component(s) that you want to deploy
1. Upload the change set and then ask Barry to deploy your change set to production.

0 comments on commit 31dffb1

Please sign in to comment.