zalando.github.io

Zalando github io page DEV repository.

Quick links

• WebSite
• Contributing
• How to deploy

Install

Clone the repository and run npm install

Run and watch for changes

npm start or gulp start

Supported versions node >= 4 and npm >= 3

Tests

Before run tests be sure you have a src/config/parameters.json file. (run gulp parameters)

npm test

Lint

npm run lint or gulp lint

Provide different parameters (env specific configuration)

Add a new json file in the src/config folder called parameters.<ENV>.json.

Example (src/config/parameters.prod.json):

{
  "CATWATCH_API" : {
    "BASE_URL": "api.catwatch.com"
  },
  "GOOGLE_ANALYTICS": {
    "TRACKING_ID": "UA-XXXXXXXX-X"
  }
}

Run the task with the env flag.

npm start -- --env=prod or gulp start --env=prod

The generated src/config/parameters.json file is the result of a merge between src/config/parameters.default.json and src/config/parameters.prod.json.

How to deploy

To deploy to the project page (gh-pages branch), for a dev preview, run:

gulp deploy

To deploy to the official zalando organization page, run:

gulp deploy --organization

The deploy task will build the artifact and publish it by doing a commit and push to the right branch/repository (gh-pages for dev preview, zalando.github.io#master when using --organization flag).

Compatibility

Tested to work with Opera 34.0+, Chrome 47.0+, Firefox 43.0+, Safari 8.0+, IE10+

Contributing

Developers interested in contributing should read the CONTRIBUTING markdown sheet.

License

Copyright 2015 Zalando SE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.