Ensure jekyll is installed:
gem install jekyll
If you need XCode dependencies, follow the Jekyll installation guide. For Windows, follow the Windows installation guide.
If you're submitting an article, you can follow these steps to clone the project, otherwise you can download the .zip bundle.
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.
If you are a project collaborator, you will have direct commit access, therefore you can run this:
git clone git@github.com: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.
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
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.
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.
Follow our contribution guidelines first.