Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 3.46 KB

README.md

File metadata and controls

99 lines (68 loc) · 3.46 KB
Raw

Install for production

  • install angular-my-modal running the following command
$ bower install angular-my-modal --save

  • Note: if you are asked about Unable to find a suitable version for angular answer angular#1.3.x which is required by angular-my-modal.

  • Note: if you are issued about github.com connection timed out just run git config --global url.https://.insteadOf git:// in terminal.

  • include angular-my-modal.min.js on your project. It should be located at bower_components/angular-my-modal/src

<script src="../bower_components/angular-my-modal/src/angular-my-modal.min.js"></script>
  • add stpa.modal and ui.bootstrap as a module dependency to your app
angular.module('my.app', [
    'stpa.modal',
    'ui.bootstrap'
])

Usage

  • insert <my-modal></my-modal> directive into your template where you want to display a modal link
<my-modal body="<h1>Hello World!</h1>">Open Modal</my-modal>

Check out documentation for more examples

Install for development

  • install node and bower on your environment
  • cd to your development folder and clone repo
$ git clone https://github.com/stpa-co/angular-my-modal
$ cd angular-my-modal
  • install module dependencies
$ npm install
$ bower install

  • Note: if you are issued about github.com connection timed out just run git config --global url.https://.insteadOf git:// in terminal.

  • serve project and do the work

$ gulp serve #Note: maybe you should have to use `sudo`
  • serve project on distribution mode
$ gulp serve:dist #Note: maybe you should have to use `sudo`
  • build project to distribution
$ gulp build #Note: maybe you should have to use `sudo`

Note: running the command gulp build should generate minified src at src/angular-my-modal.min.js, and the docs on dist/doc folder.

Note: running the command gulp serve should serve on http://localhost:3000/doc with live reload. It also should watch the changes to re-build all the things, generating minified src at src/angular-my-modal.min.js, and docs on dist/doc folder.

Note: running the command gulp serve:dist should do the same above but with all bower dependencies minified.

Note: to update project src please open an issue, fork the project, do your work, run gulp build and make a pull-request. thx =D

Note: to update docs just run gulp build or ./buil.sh, and make a pull-request into gh-pages branch only with contents of dist/doc folder. I like to work with another folder only for the docs (pointing to the same remote), maybe you will also. You can use the build.sh script located in the root to automate the process, but check it before.

Note Also check the tasks located on gulp folder for more details.

Feel free to open issues if you run into a problem or if you just have suggestions. Pull Requests are always welcome.

Changelog

  • 1.0.0
    • launched stpa-modal to easy creation of angular modals.
  • 2.0.0
    • change of project name (including in bower) to angular-my-modal. this improves the SEO as well as make more sense.
    • changes the name of callbacks and events to make more sense too.

License

The angular-my-modal is open-sourced software licensed under the MIT license. Created by @stewones