Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joernberkefeld/sfmc-boilerplate
automatically bundle your scripts for deployment
https://github.com/joernberkefeld/sfmc-boilerplate
deployment devops exacttarget marketing-cloud salesforce sfmc sfmc-boilerplate sfmc-build
Last synced: 2 months ago
JSON representation
automatically bundle your scripts for deployment
- Host: GitHub
- URL: https://github.com/joernberkefeld/sfmc-boilerplate
- Owner: JoernBerkefeld
- License: mit
- Created: 2019-05-08T06:42:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T02:50:37.000Z (over 1 year ago)
- Last Synced: 2024-08-09T16:52:45.867Z (6 months ago)
- Topics: deployment, devops, exacttarget, marketing-cloud, salesforce, sfmc, sfmc-boilerplate, sfmc-build
- Language: JavaScript
- Homepage:
- Size: 296 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SFMC Boilerplate
bundle your scripts for Cloudpages & E-Mails easily and automated
[](https://nodei.co/npm/sfmc-boilerplate/)
## Installation
```batch
> npm install --save-dev sfmc-boilerplate
```
## Usage
run ``npx sfmc-build`` in the root of your project to see all available commands.
## Config files (email.json / cloudpage.json)
This required file is used to specify loading order and other details for compiling your code. Place it inside of each folder where you keep the source files for one email or one cloudpage.
```json
{
"name": "name of your page or email",
"author": "[email protected]",
"server": {
"coreVersion": "1.1.1",
"scriptAttributes": {
"executioncontexttype": "post"
},
"dependencies": {
"other": ["server/lib/lib.something.html"],
"ssjs": ["server/lib/lib.ab.ssjs", "server/lib/lib.cd.ssjs"]
},
"src": ["server/server.ssjs"]
},
"public": ["public/index.html", "public/style.css", "public/app.js"],
"dest": "dist/bundle.html",
"template": {
"DEV":{
},
"QA": {
"_DEV": "_QA"
},
"PROD": {
"_DEV": ""
}
}
}
```
| Parameter | Description |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| ``name`` | identifies how the page or email is called in SFMC |
| ``author`` | name or email of author |
| ``server.coreVersion`` | this is used to insert "Platform.Load("core", "x.x.x");" before any SSJS code |
| ``server.scriptAttributes`` | define any attributes you want to see on auto-inserted ```` tags for SSJS |
| ``server.dependencies`` | put any re-usable libraries that you will not modifiy as part of the current app here |
| ``server.dependencies.ssjs`` | all SSJS lib files; code will be wrapped in one single ``<script runat="server">...`` |
| ``server.dependencies.other`` | any non-SSJS lib files (HTML, AMP, mixed); no wrapping code will be added |
| ``server.src`` | this is where your server-side app goes. You can use multipe files as well if needed |
| ``public`` | list your front end files here; any type is supported. JS & CSS will be autowrapped in their own ```` / ``<style>`` nodes |
| ``dest`` | define the path and file name of your output file. The path is relative to the ``cloudpage.json`` |
| ``template`` | allows you to do string replacements and will output dedicated bundles per template |
## License
MIT licensed