Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trailheadapps/ebikes-manufacturing
E-Bikes Manufacturing site built with LWR
https://github.com/trailheadapps/ebikes-manufacturing
grpc lwc lwr pubsub salesforce
Last synced: about 1 month ago
JSON representation
E-Bikes Manufacturing site built with LWR
- Host: GitHub
- URL: https://github.com/trailheadapps/ebikes-manufacturing
- Owner: trailheadapps
- License: cc0-1.0
- Created: 2019-08-29T15:45:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T00:34:01.000Z (about 2 months ago)
- Last Synced: 2024-11-01T01:22:19.795Z (about 2 months ago)
- Topics: grpc, lwc, lwr, pubsub, salesforce
- Language: JavaScript
- Homepage:
- Size: 2.77 MB
- Stars: 22
- Watchers: 3
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# E-Bikes Manufacturing Demo
This demo is built with the Lightning Web Runtime and demonstrates the use of the Pub/Sub API with Change Data Capture events and Platform Events.
🎥 Watch a short [introduction video](https://youtu.be/g9P87_loVVA).
> **Warning**
> This demo app does not use the most secure authentication mechanism. We recommend using an [OAuth 2.0 JWT Bearer Flow](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_jwt_flow.htm&type=5) for production environments.
## Installation
You can either install the app on
- [Heroku](#heroku-deploy) (quick deployment for demo purposes)
- your [local machine](#local-setup) (prefered for development purposes)
### Heroku deploy
Click on this button and follow the instructions to deploy the app:
Once deployed, see the [configuration reference](#configuration-reference) section for configuring the environment variables.
### Local setup
1. Create a `.env` file at the root of the `ebikes-manufacturing` project
```properties
SALESFORCE_AUTH_TYPE="user-supplied"
SALESFORCE_LOGIN_URL="https://test.salesforce.com"
SALESFORCE_API_VERSION="56.0"
SALESFORCE_USERNAME="YOUR_SALESFORCE_USERNAME"
SALESFORCE_PASSWORD="YOUR_SALESFORCE_PASSWORD"
SALESFORCE_TOKEN="YOUR_SALESFORCE_SECURITY_TOKEN"
PUB_SUB_ENDPOINT="api.pubsub.salesforce.com:7443"
```
1. Update the property values by referring to the [configuration reference](#configuration-reference) section
1. Install the project with `npm install`
1. Run the project with `npm start`
## Configuration reference
All variables are required.
| Variable | Description | Example |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `SALESFORCE_AUTH_TYPE` | The Salesforce authentication type for the Pub/Sub API client. Do not change this value. | `user-supplied` |
| `SALESFORCE_LOGIN_URL` | The login URL of your Salesforce org:
`https://test.salesforce.com/` for scratch orgs and sandboxes
`https://login.salesforce.com/` for Developer Edition and production | `https://test.salesforce.com` |
| `SALESFORCE_API_VERSION` | The Salesforce API version. | `56.0` |
| `SALESFORCE_USERNAME` | Your Salesforce user's password. | n/a |
| `SALESFORCE_PASSWORD` | Your Salesforce username. | n/a |
| `SALESFORCE_TOKEN` | Your Salesforce user's security token. | n/a |
| `PUB_SUB_ENDPOINT` | The endpoint used by the Pub/Sub API. | `api.pubsub.salesforce.com:7443` |