https://github.com/nathankot/angular-salvattore

https://github.com/nathankot/angular-salvattore

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nathankot/angular-salvattore
• Owner: nathankot
• Created: 2015-01-09T08:59:13.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-09T16:47:42.000Z (almost 10 years ago)
• Last Synced: 2024-11-26T22:05:01.274Z (about 1 month ago)
• Size: 109 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Makes salvattore work with angular.

[TODO - brief summary]

## Demo

http://nathankot.github.io/angular-salvattore/

## Dependencies

- required:

	[TODO]

- optional

	[TODO]

See `bower.json` and `index.html` in the `gh-pages` branch for a full list / more details

## Install

1. download the files

	1. Bower

		1. add `"angular-salvattore": "latest"` to your `bower.json` file then run `bower install` OR run `bower install angular-salvattore`

2. include the files in your app

	1. `salvattore.min.js`

	2. `salvattore.less` OR `salvattore.min.css` OR `salvattore.css`

3. include the module in angular (i.e. in `app.js`) - `nathankot.angular-salvattore`

See the `gh-pages` branch, files `bower.json` and `index.html` for a full example.

## Documentation

See the `salvattore.js` file top comments for usage examples and documentation

https://github.com/nathankot/angular-salvattore/blob/master/salvattore.js

## Development

1. `git checkout gh-pages`

	1. run `npm install && bower install`

	2. write your code then run `grunt`

	3. git commit your changes

2. copy over core files (.js and .css/.less for directives) to master branch

	1. `git checkout master`

	2. `git checkout gh-pages salvattore.js salvattore.min.js salvattore.less salvattore.css salvattore.min.css`

3. update README, CHANGELOG, bower.json, and do any other final polishing to prepare for publishing

	1. git commit changes

	2. git tag with the version number, i.e. `git tag v1.0.0`

4. create github repo and push

	1. [if remote does not already exist or is incorrect] `git remote add origin [github url]`

	2. `git push origin master --tags` (want to push master branch first so it is the default on github)

	3. `git checkout gh-pages`

	4. `git push origin gh-pages`

5. (optional) register bower component

	1. `bower register angular-salvattore [git repo url]`