# app_custom_simple_energy

> Salesforce Commerce Cloud - Simple Energy Site

Latest version **0.0.1** (published 2019-07-15) · 0 weekly downloads

## Install

```sh
npm install app_custom_simple_energy
pnpm add app_custom_simple_energy
yarn add app_custom_simple_energy
bun add app_custom_simple_energy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-07-15 |
| First published | 2019-07-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 51.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | simpleenergy_admin |

## Links

- npm: https://www.npmjs.com/package/app_custom_simple_energy
- npm.io page: https://npm.io/package/app_custom_simple_energy

## Dependencies (10)

- [jquery](https://npm.io/package/jquery.md) ^3.1.1
- [rebuild](https://npm.io/package/rebuild.md) ^0.1.2
- [bootstrap](https://npm.io/package/bootstrap.md) ^4.3.1
- [cleave.js](https://npm.io/package/cleave.js.md) ^1.0.2
- [font-awesome](https://npm.io/package/font-awesome.md) ^4.6.3
- [flag-icon-css](https://npm.io/package/flag-icon-css.md) ^2.3.0
- [jquery-validation](https://npm.io/package/jquery-validation.md) ^1.19.0
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) ^0.19.1
- [@simpleenergy/se-npm-parade](https://npm.io/package/@simpleenergy/se-npm-parade.md) ^1.0.5
- [@simpleenergy/marketplace-components](https://npm.io/package/@simpleenergy/marketplace-components.md) 0.9.30

## Recent versions

- 0.0.1 (latest) — 2019-07-15

## README

# 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.

---
_Source: https://npm.io/package/app_custom_simple_energy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._