Skip to content

matthewcpaul/generator-rapid

Repository files navigation

Rapid Generator Build Status

Yeoman generator that scaffolds out a front-end web app using gulp-armadillo for the build process and Rapid Design System for the SCSS library.

GitHub Setup

GitHub Enterprise

Create a github.ibm.com account

Travis CI

Create a travis.innovate.ibm account

SSH Key

Generate an SSH Key and add it to your GitHub Enterprise account

Prerequisites

Node

Gulp

Install Gulp globally:

npm install -g gulp

Yeoman

First, you need to install Yeoman. You only have to ask for her once, then she packs up and moves into your hard drive.

Open up your terminal, and in any directory, run:

npm install -g yo

Installation

Rapid Generator is available as a package on IBM’s NPM Enterprise registry. To get access, follow these instructions to authenticate with your w3id. You can initiate the authentication by logging in with the @whitewater scope:

npm login --registry=https://npm-registry.whitewater.ibm.com --scope=@whitewater

Yeoman Generator

Yeoman travels light. She didn't pack any generators when she moved in. You can think of a generator like a plug-in, and like Yeoman herself, you only have to ask for generators once. This project is all about the Rapid Design System, so let’s grab that generator.

To install generator-rapid:

npm install -g @whitewater/generator-rapid

Yo Rapid

Then, back in your development directory, run Yeoman to create a new project:

yo @whitewater/rapid

Automated deploys to GitHub

Almost everything is set up for you to deploy your site to GitHub Pages with Travis CI.

Personal access token

You need to create an personal access token with the repo scope. Keep this a secret! It's what lets Travis CI write to your gh-pages branch and deploy for you!

Enable GitHub Repo from Travis CI

Navigate to https://travis.innovate.ibm.com/profile/{github-username}, click sync now, and then toggle your repository on

Set environment variable

Once you've got your token, in your Travis CI environment variables, add a GH_TOKEN variable and set it to your token.

Push to GitHub Enterprise

Back in your terminal, push your project up to GitHub

git add .
git commit -m ":tada: Initial commit"
git push origin master

About

Yeoman generator for Rapid

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published