Intel Crosswalk

Running the project

This static site for Crosswalk is built with:

• Node.js
• Harp, the static web server with build-in preprocessing
• KSS, which creates the styleguide

First, install Node.js. Then, run the following commands:

# Install Harp. You may need to preface this command with `sudo`
npm install --global harp

# Clone this project from GitHub
git clone https://github.com/chloi/intel-crosswalk

# Install the project’s dependencies
npm install

# Serve the project
harp server

# The project is now available at http://localhost:9000

Run in production

To run Harp in production:

NODE_ENV=production harp server --port 80

You can also use Harp to compile the site down to flat files, which can then be hosted on any web server. These have been included within the repository already.

harp compile

Note that this site has been built to take advantage of Harp’s niceties, so the web server should:

• Create clean URLs by rewriting, for example, about.html to about/
• Allow absolute paths from/

Build the Styleguide

This site comes with its markup and CSS modules documented in a Styleguide. It’s comparable to a miniature version of the documentation for Bootstrap, where each module has an example and the accompanying code.

To build the Styleguide, run the following commands:

# Install dependencies
npm install -g kss

# Build the Styleguide
npm run styleguide

# Serve the project
harp server

# Site and Styleguide now available at http://localhost:9000/styleguide