Salesforce Sample App part of the sample gallery. Event Management use case. Get inspired and learn best practices.
Switch branches/tags
Nothing to show
Clone or download
zaynelt Merge pull request #18 from trailheadapps/zt/w19cleanup
Changes to scratch org config, forceignore
Latest commit 5edbdb2 Oct 17, 2018

README.md

Easy Spaces Sample App

CircleCI

Easy Spaces is a fictional event management company that creates and manages custom pop-up spaces for companies and individuals. Easy Spaces helps customers create temporary spaces like cafés, game rooms or themed rooms for special occasions in their offices and homes.

Thumbnail

Table of Contents

Installation

Installing Easy Spaces using Salesforce DX

This is the recommended installation option for developers who want to experience the app and code.

  1. Authenticate with your hub org (if not already done):

    sfdx force:auth:web:login -d -a myhuborg
  2. Clone this repository:

    git clone https://github.com/trailheadapps/easy-spaces
    cd easy-spaces
  3. Create a scratch org and provide it with an alias (easyspaces in the command below):

    sfdx force:org:create -s -f config/project-scratch-def.json -a easyspaces
  4. Push source to your scratch org:

    sfdx force:source:push
  5. Assign two EasySpaces permission sets to the default user:

    sfdx force:user:permset:assign -n EasySpacesObjects
    sfdx force:user:permset:assign -n SpaceManagementApp
  6. Load sample data:

    sfdx force:data:tree:import -p ./data/Plan1.json
    sfdx force:data:tree:import -p ./data/Plan2.json
  7. Open the scratch org:

    sfdx force:org:open
  8. Follow the steps in the 'Completing the Installation' section below to activate the app theme.

Installing Easy Spaces by URL

Use this option if you don't have Salesforce DX configured and want to experience the sample app. You'll be installing a series of unlocked packages.

  1. Sign up for a Developer Edition (DE) org.

  2. Enable MyDomain in your DE org. Instructions to do this are here.

  3. Click this link to install the es-base-objects package and choose Install for All Users.

  4. Click this link to install the es-base-code package and choose Install for All Users.

  5. Click this link to install the es-base-styles package and choose Install for All Users.

  6. Click this link to install the es-space-mgmt package and choose Install for All Users.

  7. From the command line, enter to following commands to clone this repository. You'll want to do this to get the files with sample data on your computer:

    git clone https://github.com/trailheadapps/easy-spaces
    cd easy-spaces
  8. Import Lead data:

    • In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
    • Click Launch Wizard.
    • Click the Standard objects tab, click Leads, and click Add New Records.
    • Drag Lead_Data.csv from the data folder of this project to the upload area.
    • Click Next, Next, and Start Import.
  9. Import Contact data:

    • In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
    • Click Launch Wizard.
    • Click the Standard objects tab, click Accounts and Contacts, and click Add New Records.
    • Drag Contact_Data.csv from the data folder of this project to the upload area.
    • Click Next, Next, and Start Import.
  10. Import Market data:

    • In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
    • Click Launch Wizard.
    • Click the Custom objects tab, click Market, and click Add New Records.
    • Drag Market_Data.csv from the data folder of this project to the upload area.
    • Click Next, Next, and Start Import.
  11. Import Spaces data:

    • Open the Space_Data.csv from the data folder of this project.
    • In the Market__c column, add the record Id for the correct Market imported in the previous step. Use the Market City Name column to help match spaces to the correct Market.
    • Save the changes to your file. Note: You must choose UTF-8 encoding when you save the file.
    • In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
    • Click Launch Wizard.
    • Click the Custom objects tab, click Space, and click Add New Records.
    • Drag Space_Data.csv from the data folder of this project to the upload area.
    • Click Next, Next, and Start Import.
    • If you see any issues with restricted picklist values blocking import, double-check that you saved your .csv with UTF-8 encoding and try again.
  12. Follow the instructions in the Completing the Installation section below to enable the Easy Spaces custom theme.

  13. In App Launcher, select the Space Management app.

  14. Note: Before trying to work with the Spaces Designer, use the Reservation Manager to create some draft reservations.

  15. Have fun exploring!

Completing the Installation

Activate the Easy Spaces theme

  1. In Setup, navigate to Themes and Branding
  2. Activate the Easy Spaces theme

Features

A quick overview of the features you can explore in Easy Spaces:

  • Modular app design and Unlocked Packages
  • Lightning Console APIs & Navigation Methods
  • Lightning Flow
    • Dynamic flow interview components
    • Custom flow screen components
    • Local Action components
  • Custom Lightning Page Templates
  • Lightning Themes and Design Token Bundles
  • Custom Metadata Types

Code Highlights

Dynamic Flows and Local Action Components

The spaceDesigner and reservationHelper components render flow interviews dynamically, by using the lightning:flow base component. You can see the customerDetails and smartGallery components at work as screens in these dynamic flows. Both of these components use the functionality of the lightning:availableForFlowScreens interface to control flow navigation actions.

See this blog post for more detail about custom flow navigation and dynamic flow interviews.

Components used as Lightning Flow screens also enforce a convention in the markup of their design files, to help developers better track how attributes are being used by flow interviews. See the customerDetails and smartGallery component design files for examples.

Object-Agnostic Design

The customerList and customerTile components can display information from Contact objects or Lead objects.

Two instances of customerList component on canvas in Lightning App Builder

The customerList component uses a design attribute to allow for users working in Lightning App Builder to control which object an instance of the component should display:

customerList component design attribute as picklist in Lightning App Builder

This is just one example of object-agnostic design at work in Easy Spaces. See this blog post for more detail about this pattern.

Control Navigation and Behavior in Console Apps

Easy Spaces uses the Lightning Console JavaScript API to control navigation and behaviors of tabs and subtabs in the Space Management console app. You can see the lightning:workspaceAPI component at work in the openRecordAction component, which enables flow interviews to navigate users to a new subtab. The reservationHelper and spaceDesigner components use the lightning:navigationItemAPI component to refresh custom Lightning Page tabs in the background as a user works. You can get more detail about using the Workspace API in your components in this blog post.

Modular Design and Unlocked Packaging

Easy Spaces illustrates how to organize application metadata into granular units or modules. This approach is reflected in the design patterns at work throughout the application, like the use of design tokens and object-agnostic components. But you'll also see this at work in the structure of the Easy Spaces repo itself.

The Easy Spaces application is made of several, interdependent unlocked packages. The dependecies between the Easy Spaces packages are listed in the sfdx-project.json file for this repo.

You can also explore the contents of each package by looking at the related package folder within this repo. The path attribute entries in the sfdx-project.json show which folder contains the metadata for a particular package.

For more about how the Easy Spaces metadata is organized into package modules, check out this post.