Kickboard

Kickboard is an application that teaches our customers how to swim in the vast depths of digital transformation

Installing the app using a Scratch Org

1. Set up your environment. Follow the steps in the Quick Start: Lightning Web Components Trailhead project. The steps include:

   • Enable Dev Hub in your Trailhead Playground
   • Install Salesforce CLI
   • Install Visual Studio Code
   • Install the Visual Studio Code Salesforce extensions, including the Lightning Web Components extension

2. If you haven't already done so, authorize your hub org and provide it with an alias (myhuborg in the command below):

   sfdx auth:web:login -d -a myhuborg
   

3. Clone the Kickboard repository:

   git clone https://github.com/SalesforceLabs/Kickboard
   cd Kickboard
   

4. Create a scratch org and provide it with an alias (kickboard in the command below):

   sfdx force:org:create -s -f config/project-scratch-def.json -a kickboard
   

5. Push the app to your scratch org:

   sfdx force:source:push
   

6. Assign the Kickboard User permission set to the default user:

   sfdx force:user:permset:assign -n Kickboard_User
   

7. Assign the below permission sets to the admin user:

   sfdx force:user:permset:assign -n Kickboard_Admin
   

   sfdx force:user:permset:assign -n Kickboard_Export_Lane
   

8. Open the scratch org:

   sfdx force:org:open
   

9. Navigate to the Kickboard app, and follow the initial setup instructions.

Optional Installation Instructions

This repository contains several files that are relevant if you want to integrate modern web development tooling to your Salesforce development processes, or to your continuous integration/continuous deployment processes.

Code formatting

Prettier is a code formatter used to ensure consistent formatting across your code base. To use Prettier with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The .prettierignore and .prettierrc files are provided as part of this repository to control the behavior of the Prettier formatter.

Code linting

ESLint is a popular JavaScript linting tool used to identify stylistic errors and erroneous constructs. To use ESLint with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The .eslintignore file is provided as part of this repository to exclude specific files from the linting process in the context of Lightning Web Components development.

Pre-commit hook

This repository also comes with a package.json file that makes it easy to set up a pre-commit hook that enforces code formatting and linting by running Prettier and ESLint every time you git commit changes.

To set up the formatting and linting pre-commit hook:

1. Install Node.js if you haven't already done so

2. Run npm install in your project's root folder to install the ESLint and Prettier modules (Note: Mac users should verify that Xcode command line tools are installed before running this command.)

Prettier and ESLint will now run automatically every time you commit changes. The commit will fail if linting errors are detected. You can also run the formatting and linting from the command line using the following commands (check out package.json for the full list):

npm run lint:lwc
npm run prettier