Build Status:
Project template built from FlippyUI. grunt-starter-kit includes:
- A Git Clone from FlippyUI grunt-starter-kit
- Project specific Grunt runner.
- bower.json and package.json for common dependencies.
- AMD Javascript sources specific to grunt-starter-kit.
- Reference Design Library: http://flippydisk.com/
-
Fork the JI repo, not a local clone (this is for easy pull request references)
-
Create a new folder on your local, and init a git repo
git init
-
Add a reference to your repo as the
origin
and the parent repo as theupstream
git remote add upstream https://github.com/Psykoral/JI.git git remote add origin https://github.com/{yourRepo}/JI.git
-
Grab the files from the
upstream
git pull upstream master
-
Make a local change to any file, doesn't matter which one or how big the change.
-
Commit it
git commit -m "Testing Jenkins and Github PR integration"
-
Push it to your
origin
git push origin master
-
Create a Pull Request from your repo to the
upstream
repo
- Watch Github connect to Jenkins to start a build, and see the Jenkins server in the
details
link
- Jenkins, user:
tester
, pass:JenkinsTester
- Failures are returned:
- Successful builds are returned:
- After a merge, the regular build job should run.
- For simple updates that shouldn't affect a build, you can skip the auto PR build by putting
[skip ci]
in the PR comment.
-
Install Git
-
Install NodeJS >=4
-
Install Grunt ~1.0.1
npm install -g grunt-cli
-
Install Bower
npm install -g bower
-
Install PhantomJS
npm install -g phantomjs-prebuilt
- Clone grunt-starter-kit
git clone https://github.com/Psykoral/grunt-starter-kit.git
- Run all NPM and Bower items
./update.sh
- Windows users run this with GitBash.exe
- *nix & Mac users you might need to chmod +x this file to allow it to be executable.
-
grunt live
- Runs the Example site
-
grunt jsdoc
- Runs JSDoc API documentation
- Run after 'grunt live', keep that server running then go to http://localhost/jsdoc/
-
grunt test
- Runs Jasmine tests in the console (also runs on 'grunt live')
-
grunt livetests
- Runs Jasmine tests in a browser
The distribution package is the end result of building this project:
dist/
├── css/
├── jenkins-integration.css
├── js/
├── jenkins-integration.js
Want to use FlippyUI? See our Contributing documentation.
Developed under the MIT License.