Skip to content

Instantly share code, notes, and snippets.

@scottbaggett
Last active December 15, 2016 04:27
Show Gist options
  • Save scottbaggett/2279d5325ae0eacfad1860744fc04c7e to your computer and use it in GitHub Desktop.
Save scottbaggett/2279d5325ae0eacfad1860744fc04c7e to your computer and use it in GitHub Desktop.
Installation and Development Instructions for Lexus International

Lexus International

Requirements

  • PHP 5.6
  • MySQL 5.6
  • Node 6
  • Ruby 2.3
  • Composer

Development Tool Install

$   composer install
$   npm install
$   gem install compass breakpoint

PHP/Apache/Mysql

  1. Your local web-server should be mapped to http://dev.lexus-int.com in order to use BrowserSync to get live reloading of your modules as you are building the article.
  2. Markdown support requires the PHP module 'mbstring' to be enabled in php.ini http://php.net/manual/en/mbstring.installation.php

Development

$   gulp --watch

Reference Article

We have created a reference article that has examples of all module types in it:

Creating Articles

Open the folder /resources/article-content/reference-article

index.json (data that powers the templates)
/assets (contains the images)

To create a new article, just create a folder inside /resources/article-content/ and use the article URL as the folder. Do not use spaces or special charaters in the name.

example: /resources/article-content/my-new-article-title
  • Create (or duplicate) index.json in the root of the new folder.
  • Create a folder called assets to put images in.

Note the category array inside the reference index.json

"categories": [
    "top-stories",
    "experiences"
  ]

To categorize articles, just choose from the following categories:

  • top-stories
  • experiences
  • craftsmanship
  • design
  • technology

Please review the reference /resources/article-content/reference-article/index.json for details on how the articles are composed from individual modules

* NOTE: Whenever adding articles, the gulp task (gulp --watch) rerun so that the assets are copied into the public folder

Press Room

Press releases are just articles, so add the category press-room

Production Build

To output files for production, run the production gulp task. $ gulp --production

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment