https://github.com/kamranayub/pluralsight-angular

My sample app code base while working through Pluralsight's AngularJS Fundamentals course. Using Bootstrap 3 and with extra functionality/learnings added.
https://github.com/kamranayub/pluralsight-angular

Last synced: 29 days ago
JSON representation

My sample app code base while working through Pluralsight's AngularJS Fundamentals course. Using Bootstrap 3 and with extra functionality/learnings added.

• Host: GitHub
• URL: https://github.com/kamranayub/pluralsight-angular
• Owner: kamranayub
• Created: 2013-10-02T05:23:00.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-02T05:23:10.000Z (about 11 years ago)
• Last Synced: 2024-04-13T16:07:08.399Z (7 months ago)
• Language: JavaScript
• Size: 492 KB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# angular-seed — the seed for AngularJS apps

This project is an application skeleton for a typical [AngularJS](http://angularjs.org/) web app.

You can use it to quickly bootstrap your angular webapp projects and dev environment for these

projects.

The seed contains AngularJS libraries, test libraries and a bunch of scripts all preconfigured for

instant web development gratification. Just clone the repo (or download the zip/tarball), start up

our (or yours) webserver and you are ready to develop and test your application.

The seed app doesn't do much, just shows how to wire two controllers and views together. You can

check it out by opening app/index.html in your browser (might not work file `file://` scheme in

certain browsers, see note below).

_Note: While angular is client-side-only technology and it's possible to create angular webapps that

don't require a backend server at all, we recommend hosting the project files using a local

webserver during development to avoid issues with security restrictions (sandbox) in browsers. The

sandbox implementation varies between browsers, but quite often prevents things like cookies, xhr,

etc to function properly when an html page is opened via `file://` scheme instead of `http://`._

## How to use angular-seed

Clone the angular-seed repository and start hacking...

### Running the app during development

You can pick one of these options:

* serve this repository with your webserver

* install node.js and run `scripts/web-server.js`

Then navigate your browser to `http://localhost:/app/index.html` to see the app running in

your browser.

### Running the app in production

This really depends on how complex is your app and the overall infrastructure of your system, but

the general rule is that all you need in production are all the files under the `app/` directory.

Everything else should be omitted.

Angular apps are really just a bunch of static html, css and js files that just need to be hosted

somewhere, where they can be accessed by browsers.

If your Angular app is talking to the backend server via xhr or other means, you need to figure

out what is the best way to host the static files to comply with the same origin policy if

applicable. Usually this is done by hosting the files by the backend server or through

reverse-proxying the backend server(s) and a webserver(s).

### Running unit tests

We recommend using [jasmine](http://pivotal.github.com/jasmine/) and

[Karma](http://karma-runner.github.io) for your unit tests/specs, but you are free

to use whatever works for you.

Requires [node.js](http://nodejs.org/), Karma (`sudo npm install -g karma`) and a local

or remote browser.

* start `scripts/test.sh` (on windows: `scripts\test.bat`)

  * a browser will start and connect to the Karma server (Chrome is default browser, others can be captured by loading the same url as the one in Chrome or by changing the `config/karma.conf.js` file)

* to run or re-run tests just change any of your source or test javascript files

### End to end testing

Angular ships with a baked-in end-to-end test runner that understands angular, your app and allows

you to write your tests with jasmine-like BDD syntax.

Requires a webserver, node.js + `./scripts/web-server.js` or your backend server that hosts the angular static files.

Check out the

[end-to-end runner's documentation](http://docs.angularjs.org/guide/dev_guide.e2e-testing) for more

info.

* create your end-to-end tests in `test/e2e/scenarios.js`

* serve your project directory with your http/backend server or node.js + `scripts/web-server.js`

* to run do one of:

  * open `http://localhost:port/test/e2e/runner.html` in your browser

  * run the tests from console with [Karma](http://karma-runner.github.io) via

    `scripts/e2e-test.sh` or `script/e2e-test.bat`

### Continuous Integration

CloudBees have provided a CI/deployment setup:



If you run this, you will get a cloned version of this repo to start working on in a private git repo, 

along with a CI service (in Jenkins) hosted that will run unit and end to end tests in both Firefox and Chrome.

### Receiving updates from upstream

When we upgrade angular-seed's repo with newer angular or testing library code, you can just

fetch the changes and merge them into your project with git.

## Directory Layout

    app/                --> all of the files to be used in production

      css/              --> css files

        app.css         --> default stylesheet

      img/              --> image files

      index.html        --> app layout file (the main html template file of the app)

      index-async.html  --> just like index.html, but loads js files asynchronously

      js/               --> javascript files

        app.js          --> application

        controllers.js  --> application controllers

        directives.js   --> application directives

        filters.js      --> custom angular filters

        services.js     --> custom angular services

      lib/              --> angular and 3rd party javascript libraries

        angular/

          angular.js        --> the latest angular js

          angular.min.js    --> the latest minified angular js

          angular-*.js      --> angular add-on modules

          version.txt       --> version number

      partials/             --> angular view partials (partial html templates)

        partial1.html

        partial2.html

    config/karma.conf.js        --> config file for running unit tests with Karma

    config/karma-e2e.conf.js    --> config file for running e2e tests with Karma

    scripts/            --> handy shell/js/ruby scripts

      e2e-test.sh       --> runs end-to-end tests with Karma (*nix)

      e2e-test.bat      --> runs end-to-end tests with Karma (windows)

      test.bat          --> autotests unit tests with Karma (windows)

      test.sh           --> autotests unit tests with Karma (*nix)

      web-server.js     --> simple development webserver based on node.js

    test/               --> test source files and libraries

      e2e/              -->

        runner.html     --> end-to-end test runner (open in your browser to run)

        scenarios.js    --> end-to-end specs

      lib/

        angular/                --> angular testing libraries

          angular-mocks.js      --> mocks that replace certain angular services in tests

          angular-scenario.js   --> angular's scenario (end-to-end) test runner library

          version.txt           --> version file

      unit/                     --> unit level specs/tests

        controllersSpec.js      --> specs for controllers

        directivessSpec.js      --> specs for directives

        filtersSpec.js          --> specs for filters

        servicesSpec.js         --> specs for services

## Contact

For more information on AngularJS please check out http://angularjs.org/