mohammedzamakhan / ngmigrate.github.io

Angular 2 migration guide, porting 1.x concepts to Angular 2.

Build this project

Install jekyll

Ensure jekyll is installed:

gem install jekyll

If you need XCode dependencies, follow the Jekyll installation guide. For Windows, follow the Windows installation guide.

Installing the project

If you're submitting an article, you can follow these steps to clone the project, otherwise you can download the .zip bundle.

Forking

If you're a project collaborator, see the next step. If not, you'll need to Fork this repository to your own GitHub account, then git clone your copy before submitting a PR:

git clone https://github.com/YOUR_USERNAME/ngmigrate.github.io.git
cd ngmigrate.github.io
git checkout -b YOUR_BRANCH

Push all changes to your branch, and then submit a PR, we'll review and merge your PR once ready.

Project collaborators

If you are a project collaborator, you will have direct commit access, therefore you can run this:

git clone [email protected]:ngmigrate/ngmigrate.github.io.git
cd ngmigrate.github.io
git checkout -b YOUR_BRANCH

Push all changes to that branch, and then submit a PR before merging to master.

Installing dependencies

First, you'll need to make sure you have gulp installed:

npm install --global gulp

Next, you'll need to npm install the other dev-dependencies, run this from the ngmigrate.github.io root folder from your git clone:

cd ngmigrate.github.io
npm install

Running the server

Gulp is setup to make it easier to run all the tasks, to run the project simply run:

npm start

This will start serving the project from localhost:4000, with livereload functionality.

JavaScript

All JavaScript is located inside _scripts, excluding npm dependencies. You can write ES2015 here as the output is transpiled through Babel and outputted inside js/bundle.min.js, so don't edit that file directly - and remember to push the bundled file so that GitHub pages can compile it from the static directory.

Ready to make a PR?

Follow our contribution guidelines first.