https://github.com/aurbano/angular-requirejs-seed
Starter project with Angularjs Requirejs Bower Grunt and Bootstrap
https://github.com/aurbano/angular-requirejs-seed
angularjs bower grunt javascript requirejs starter-kit
Last synced: 7 months ago
JSON representation
Starter project with Angularjs Requirejs Bower Grunt and Bootstrap
- Host: GitHub
- URL: https://github.com/aurbano/angular-requirejs-seed
- Owner: aurbano
- License: mit
- Created: 2015-02-21T16:51:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-29T09:27:33.000Z (over 10 years ago)
- Last Synced: 2025-01-18T15:51:29.646Z (9 months ago)
- Topics: angularjs, bower, grunt, javascript, requirejs, starter-kit
- Language: JavaScript
- Homepage: https://aurbano.github.io/angular-requirejs-seed
- Size: 654 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Starter project with Angularjs Requirejs Bower Grunt and Bootstrap
## Getting started
Fork or Clone this project, rename and run the following to set your environment up. You'll need [npm](http://nodejs.org/download/) and [grunt](http://gruntjs.com/installing-grunt) for this to work.
First install dependencies:
```sh
$ npm install -g grunt-cli
$ npm install -g bower
$ npm install
$ bower install
```
Now just open `index.html` in your browser and let the magic happen!
## Add/Remove Dependencies
We are using [bower](http://bower.io/) to handle all the dependencies, to add a new one you can run any of the following:
```sh
# registered package
$ bower install jquery
# GitHub shorthand
$ bower install desandro/masonry
# Git endpoint
$ bower install git://github.com/user/package.git
# URL
$ bower install http://example.com/script.js
```
Once you are done, you need to update the routes in Requirejs for them to be available.
Don't worry though, Grunt will do that for you, on the default task. Just run:
```sh
$ grunt
```
## Building
To test locally you develop the Angularjs app inside `app/` and the run `index.html` in your browser.
Once you have something good going you can build it automatically with grunt:
```
$ grunt build
```
Behind the scenes grunt will:
1. Delete the `build/` folder
2. Minify and concatenate the app using Requirejs' optimizer
3. Point the Requirejs script in `index.html` to the built file
4. Copy the `assets/` folder and `bootstrap` to the `build` folder
To test open `build/index.html` in your browser.
## Deploying
At the moment the sample is configured to deploy itself to Github Pages, to deploy simply run:
```sh
$ grunt deploy
```
Other sites like heroku, openshift, or virtually anything could be easily configured, if you do so please send a pull request.
## Contributing/Roadmap
Some pending tasks/ideas I have for this sample app are:
- Multiple deploy options exposed as `$ grunt deploy `
- Functional Angularjs app with several views, providers...
- Non bootstrap option
- Make this into a Yeoman generator
- Add tests?
## Meta
Developed by [Alejandro U. Alvarez](http://urbanoalvarez.es) - MIT License
[](https://github.com/aurbano)