To get up and developing;
- We use the fork & pull Git model, fork a local copy.
- Install Git, Node, Gulp, Bower
- Run
npm install -g bower gulp nodemonto install Bower, Gulp.js and nodemon globally. - Run
npm installto install all NPM packages.
Let's build something awesome. We can make it happen with your help.
We use the fork & pull model to accept new code into the project. If you aren't familiar with that workflow, Github's Using Pull Requests article is a great primer.
If you plan on contributing more than once and want to keep your fork up to date with this project we recommend checking out these guides on configuring a remote for a fork and syncing a fork.
The easiest way to get involved is to join in the conversation on this repositories issue tracker. This is where we work out ideas for new features and fixes. Once we have the details worked out here we can easily implement against a defined specification.
We make use of the airbnb style guide. Please make sure that all contributed code is in line with this style guide. Code will be rejected if it is not in line with this standard.
To get developing you will need to have a few programs.
Follow the installation instructions on the git website to get setup with git.
Note For Windows Users: mysysgit comes with a tool called git bash which is the recommened shell to run commands in.
Next make sure you have Node.js installed on your machine. If you are unsure if you have Node on your computer you can run this command in your terminal to check.
$ node -vIf your terminal returns a version number then you are good to go. If it does not return a version number then visit the Node.js downloads page and download and install a copy on your machine.
With the Node.js installer you will also get the NPM CLI (Node Package Manager Command Line Interface) which your computer will use to download packages from the NPM registry.
Install Bower, Gulp.js and nodemon globally on your machine.
$ npm install -g bower gulp nodemonInstall project Node module and Bower dependencies.
$ npm install
$ cd site && bower install && cd ..You can view your directives in a runtime environment as you develop. The sandbox environment will allow you to test runtime markup and options. The sandbox is a page on the BossyUI website, to run the website locally:
$ gulp siteYou can then see changes you are making to directives as you develop them at http://localhost:3000/sandbox.
Before you start work please create an Issue in this repo. The Issue title should reflect the Directive/Widget you are working on, ie:
"GRAPH: Short description on what you are working on"
Your working branch should be named with both the Directive/Widget name and the Issue number, ie:
"GRAPH-1234"
When committing code, you will need to prefix your comments with the branch name. Pull request will be rejected if these rules are not met.
Before you go to Github and submit your pull request be sure to run:
$ gulp jshintAs long as those tasks do not present you with any errors you are ready to submit your pull request.
We don't write perfect software and systems and platforms change, so if you've found a bug log it in the issue tracker so we can get started fixing it.
Built with LOVE by:
Geoff Lawson [email protected]
Kevin Buffardi [email protected] (CSU Chico Faculty Advisor)
Jason Merino [email protected]
Dan Green [email protected]
Dan Sluis [email protected]
Tauseef Jamadar [email protected]
Tuhin Shukla [email protected]
Erik Mellum
CSU Chico CS Students:
Taber Fitzgerald
Alen Maragoul
Chue Vang
Colin Baldwin
Francisco Tadillo
James Crean
Jay German
Lukas Fink
Martin Mojica
Patrick Barnum
Shelby Martin
Spencer McWilliams
Sumit Dorle
CSU Chico Design Students:
Carly Culver
Christie Landrie
Mary Trujillo