Commit 1ed4f03e authored by Caleb Weeks's avatar Caleb Weeks

adding handlebars guide

parent c45ca916
## JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
*.iml
.idea/
.tmp/
.vscode/
jsconfig.json
## Sublime workspace files
*.sublime-workspace
public
public/test/
# node/bower
node_modules/
npm-debug.log
bower_components/
# Mac system files
.DS_Store
# Blacklight files
blacklight_modules/
# sass
.sach-cache/
# build
public
# generated breakpoints sass file
asset-build/scss/base/_breakpoints.scss
# Conflict resolution files
*.orig
This diff is collapsed.
## Quickstart Guide ##
## Required Dependencies ##
1. Node.js (https://nodejs.org/en/download/package-manager/)
2. GIT (https://git-scm.com/downloads)
3. ImageMagick (https://www.imagemagick.org/script/binary-releases.php)
4. Valid credentials and permissions for Gitlab (https://gitlab.entropy.cc/fs-blacklight/fs-blacklight) and FS Stage AEM instance (https://author13.stage.fourseasons.com)
5. An SSH key configured in your Gitlab account (https://docs.gitlab.com/ce/ssh/README.html)
## Installation Steps ##
#### 1. Install Blacklight Command Line Utility ####
```bash
npm install -g blacklight-cli
```
#### 2. Clone fs-blacklight GIT repo ####
```bash
git clone git@gitlab.entropy.cc:fs-blacklight/fs-blacklight.git
cd fs-blacklight
npm install
```
#### 3. Setup Config file ####
```
cp config/local.json.dist config/local.json
```
Open local.json in your editor of choice, and configure your AEM credentials and ImageMagick executable
```javascript
//...
"author":{
"port":4400, // <-- this can be set to any port you want Blacklight to run on
"sling":{
"baseUri": "https://author13.stage.fourseasons.com",
"username": "",
"password": ""
}
}
//...
"imageOptimizer":{
//...
"imagemagick-convert":"/usr/local/bin/convert" // <-- set to your path.
}
```
#### 4. Install Core modules ####
```
bl module install fshr.site -u git@gitlab.entropy.cc:fs-blacklight/site.git
bl module install blacklight.edit -u git@gitlab.entropy.cc:blacklight/edit.git
```
#### 5. Install Project modules
```
bl module install fshr.shared
bl module install fshr.magazine
```
#### 6. Start Blacklight and verify pages are working correctly ####
```
bl start
```
In a web browsers navigate to http://localhost:4400/content/fourseasons/en/properties/santafe/destination/things-to-do
The page should look the same as it does here: http://www.stage13.fourseasons.com/santafe/destination/things-to-do/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment