AndrewSouthpaw / AngularSeedProject

Base project files

Lumiata Angular Seed

---

##getting started

1. Prerequisites

2. Make sure you have registered your SSH keys with github. Here is the [link on how to set this up] (https://help.github.com/articles/generating-ssh-keys/)

3. Install Homebrew. * You can first veify you have it in the console $ brew * to install brew $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" * once installed, run $ brew doctor and $ brew update. This will check that all is good and bring down a fresh catalog of packages

4. Install Node.js using homebrew with $ brew install node

5. Install Bower using homebrew with $ brew install bower

6. Install Grunt using npm (Node Package Manager) $ npm install -g grunt. The -g means globally.

7. Make sure you have a code directory in your home folder $ cd ~/ and then $ mkdir code. For easy access in the your finder side bar $ open ~/ then drag the code folder to the sidebar so the line shows up between existing folders and let go.

8. Switch to the code directory and the clone this repo git clone [e-mail]:lumiata/AngularSeedProject.git

9. Setup a new remote repo where you see fit to store your project on github

10. You should have a new folder in your code folder called AngularSeedProject. Rename this to whatever you want(e.g., fooProject)

11. Switch to this directory and run git remote delete origin git remote remove origin

12. Add your new repo to the origin git remote add origin [e-mail]:lumiata/TomsAwesomeProject.git (NOTE you need to put in the address of the repo you created in step 5.

13. Push up this proejct to your repo git push origin

14. Install the dependencies with npm install and then bower install

15. Start the app! grunt serve

16. Run unit\e2e tests npm test

##unit testing

1. We are using Jasmine for unit testing. Your tests belong in test\unit\<MODULE_NAME>\*Spec.js. They must follow the *Spec.js naming scheme
2. Your services\controllers\filters code must be covered within reason.

##end to end testing

1. Your directives must be end to end tested and if you are following best practices, this should be possible as they should be isolated in scope and have all dependencies injectable

##contributing

1. First make sure you have read the javascript style guide. When in doubt, refer to this on issues of style.
2. If you code contains 3 letter variable names, it will not be going in (Hint!)
3. To help with code quality be sure your code passes the linting tests by running $ grunt from the command line
4. Test your compiled site by starting the node server, switch to ther server directory and run node express.js. The default port is 7003
5. When you are ready to submit your pull request, push your feature branch and issue a pull request on develop. We have continuous integration on develop. Your commit messages should be prefixed with the JIRA issue number.