app_custom_simple_energy v0.0.1

Salesforce Commerce Cloud Simple Energy Site

Setup environment for new project

Download and install dependencies

MAKE SURE YOU ARE USING NODE VERSION 8.9.4

• Clone the repository. Recommended to do it with git commands.
  • git clone --recursive git@github.com:simpleenergy/commerce-cloud-marketplace.git to include the submodules
• Before loading the submodules, gain access to Salesforce Commerce Cloud by following the below steps
  • Click on https://cc-community-authmgr.herokuapp.com/
  • Enable Two-Factor Authentication for your GitHub account.
  • Navigate to the XChange User Community Profile, and log in with Account Manager credentials. If you have an active session on XChange, you might be logged in automatically.
  • On the left side, select Github. Follow the steps on the screen to authenticate, link your GitHub account, and request access.
  • At the bottom, click Visit Commerce Cloud on Github.
  • At the top, click View Invitation. Accept the invitation.
• Load submodules
  • If your repo was already cloned, load the submodules by running git submodule update --init --recursive
• Install node (if not installed already). For this one is strongly recommended use NVM (Node Version Manager).
• Install sgmf-scripts globally npm install -g sgmf-scripts.
• Install dependencies by running npm install.
• Install dependencies inside build-suite folder by running npm install rebuild node-sass.

Use build suite for deployment

• Go to ../build-suite folder
• Copy build/simple-energy.json to build/simple-energy-local.json and update connection params
• Now you can run the following commands:
  • Deploy code: grunt dist --project=simple-energy-local
  • Import sites: grunt importSite --project=simple-energy-local
  • Reindex: grunt triggerReindex --project=simple-energy-local

Troubleshooting

1. In case you have the infamous EACCES error for the global installation of the sgmf-scripts you can do one of these options:
   • Install the sgmf-scripts locally in the project.
   • Change the directories for the npm global installations. Go to this link: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally
2. If you have trouble with the grunt command try to install it globally by running: npm install -g grunt-cli.

Sync sandbox without build

• Inside this project folder, copy dw.json.example to dw.json and update connection parameters
• Run command: npm run watch to watch, compile and upload files to the sandbox
• Run command npm run watch:compile to watch and compile files (If you are using an editor like VS or Eclipse to upload changes)
• Have fun!

Running the tests

• Run command npm run test for running the unit test.
• For running the integration test you need to: 1. Set the baseUrl in the file ./test/integration/it.config.js 2. Run command npm run test:integration for tunning the integration tests.