Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.56 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.56 KB
Raw

react-lightning-boilerplate

Boilerplate repository for developing Lightning Components With React.

This provides the basic structure needed for adding React Components to your Salesforce Org via Webpack and SFDX.

Setup

  1. Fork this repo.
  2. clone your forked repo with git clone <yourRepoUrl>
  3. Install sfdx cli
  4. Install Node
  5. cd into the project directory and run yarn or npm install

Quick Start

  1. Go through Setup
  2. Run npm run deploy
  3. Open your scratch org.
  4. Go to your developer console.
  5. Open Lightning Resource > ReactDevContainerApp
  6. Click Preview and you should see something like this:

Screenshot of React Component within Lightning

Available Commands

prefix with yarn or npm run. example: yarn build

  • build - runs webpack to bundle your React src.
  • deploy - runs build and then pushes to your default scratch org

Acknowledgements

This project was influenced by this post: Lightning Container Component: Building Components with React, Angular, and Other Libraries.

Eigen X

This project is developed and maintained by @EigenX. Have questions or need help with setup? Email Us

License

See LICENSE