-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c2c4d13
commit 67c0b04
Showing
63 changed files
with
49,771 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2013 Michael Hurley | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,151 @@ | ||
KingHunt | ||
======== | ||
# angular-seed — the seed for AngularJS apps | ||
|
||
Chess problems | ||
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. | ||
|
||
* Database: [Yet Another Chess Problem Database](http://www.yacpdb.org/) | ||
* Chess engine: [Garbochess-JS](https://github.com/glinscott/Garbochess-JS) | ||
* Chess interface [chessboardjs](https://github.com/oakmac/chessboardjs) and [chess.js](https://github.com/jhlywa/chess.js) | ||
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:<port>/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: | ||
|
||
<a href="https://grandcentral.cloudbees.com/?CB_clickstart=https://raw.github.com/CloudBees-community/angular-js-clickstart/master/clickstart.json"><img src="https://d3ko533tu1ozfq.cloudfront.net/clickstart/deployInstantly.png"/></a> | ||
|
||
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/ |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/* app css stylesheet */ | ||
|
||
.menu { | ||
list-style: none; | ||
border-bottom: 0.1em solid black; | ||
margin-bottom: 2em; | ||
padding: 0 0 0.5em; | ||
} | ||
|
||
.menu:before { | ||
content: "["; | ||
} | ||
|
||
.menu:after { | ||
content: "]"; | ||
} | ||
|
||
.menu > li { | ||
display: inline; | ||
} | ||
|
||
.menu > li:before { | ||
content: "|"; | ||
padding-right: 0.3em; | ||
} | ||
|
||
.menu > li:nth-child(1):before { | ||
content: ""; | ||
padding: 0; | ||
} |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<!doctype html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<style> | ||
[ng-cloak] { | ||
display: none; | ||
} | ||
</style> | ||
<script> | ||
// include angular loader, which allows the files to load in any order | ||
/* | ||
AngularJS v1.0.7 | ||
(c) 2010-2012 Google, Inc. http://angularjs.org | ||
License: MIT | ||
*/ | ||
(function(i){'use strict';function d(c,b,e){return c[b]||(c[b]=e())}return d(d(i,"angular",Object),"module",function(){var c={};return function(b,e,f){e&&c.hasOwnProperty(b)&&(c[b]=null);return d(c,b,function(){function a(a,b,d){return function(){c[d||"push"]([a,b,arguments]);return g}}if(!e)throw Error("No module: "+b);var c=[],d=[],h=a("$injector","invoke"),g={_invokeQueue:c,_runBlocks:d,requires:e,name:b,provider:a("$provide","provider"),factory:a("$provide","factory"),service:a("$provide","service"), | ||
value:a("$provide","value"),constant:a("$provide","constant","unshift"),filter:a("$filterProvider","register"),controller:a("$controllerProvider","register"),directive:a("$compileProvider","directive"),config:h,run:function(a){d.push(a);return this}};f&&h(f);return g})}})})(window); | ||
|
||
|
||
// include a third-party async loader library | ||
/*! | ||
* $script.js v1.3 | ||
* https://github.com/ded/script.js | ||
* Copyright: @ded & @fat - Dustin Diaz, Jacob Thornton 2011 | ||
* Follow our software http://twitter.com/dedfat | ||
* License: MIT | ||
*/ | ||
!function(a,b,c){function t(a,c){var e=b.createElement("script"),f=j;e.onload=e.onerror=e[o]=function(){e[m]&&!/^c|loade/.test(e[m])||f||(e.onload=e[o]=null,f=1,c())},e.async=1,e.src=a,d.insertBefore(e,d.firstChild)}function q(a,b){p(a,function(a){return!b(a)})}var d=b.getElementsByTagName("head")[0],e={},f={},g={},h={},i="string",j=!1,k="push",l="DOMContentLoaded",m="readyState",n="addEventListener",o="onreadystatechange",p=function(a,b){for(var c=0,d=a.length;c<d;++c)if(!b(a[c]))return j;return 1};!b[m]&&b[n]&&(b[n](l,function r(){b.removeEventListener(l,r,j),b[m]="complete"},j),b[m]="loading");var s=function(a,b,d){function o(){if(!--m){e[l]=1,j&&j();for(var a in g)p(a.split("|"),n)&&!q(g[a],n)&&(g[a]=[])}}function n(a){return a.call?a():e[a]}a=a[k]?a:[a];var i=b&&b.call,j=i?b:d,l=i?a.join(""):b,m=a.length;c(function(){q(a,function(a){h[a]?(l&&(f[l]=1),o()):(h[a]=1,l&&(f[l]=1),t(s.path?s.path+a+".js":a,o))})},0);return s};s.get=t,s.ready=function(a,b,c){a=a[k]?a:[a];var d=[];!q(a,function(a){e[a]||d[k](a)})&&p(a,function(a){return e[a]})?b():!function(a){g[a]=g[a]||[],g[a][k](b),c&&c(d)}(a.join("|"));return s};var u=a.$script;s.noConflict=function(){a.$script=u;return this},typeof module!="undefined"&&module.exports?module.exports=s:a.$script=s}(this,document,setTimeout) | ||
|
||
// load all of the dependencies asynchronously. | ||
$script([ | ||
'lib/angular/angular.js', | ||
'js/app.js', | ||
'js/services.js', | ||
'js/controllers.js', | ||
'js/filters.js', | ||
'js/directives.js' | ||
], function() { | ||
// when all is done, execute bootstrap angular application | ||
angular.bootstrap(document, ['myApp']); | ||
}); | ||
</script> | ||
<title>My AngularJS App</title> | ||
<link rel="stylesheet" href="css/app.css"> | ||
</head> | ||
<body ng-cloak> | ||
<ul class="menu"> | ||
<li><a href="#/view1">view1</a></li> | ||
<li><a href="#/view2">view2</a></li> | ||
</ul> | ||
|
||
<div ng-view></div> | ||
|
||
<div>Angular seed app: v<span app-version></span></div> | ||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<!doctype html> | ||
<html lang="en" ng-app="myApp"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>My AngularJS App</title> | ||
<link rel="stylesheet" href="css/app.css"/> | ||
</head> | ||
<body> | ||
<ul class="menu"> | ||
<li><a href="#/view1">view1</a></li> | ||
<li><a href="#/view2">view2</a></li> | ||
</ul> | ||
|
||
<div ng-view></div> | ||
|
||
<div>Angular seed app: v<span app-version></span></div> | ||
|
||
<!-- In production use: | ||
<script src="//ajax.googleapis.com/ajax/libs/angularjs/1.0.7/angular.min.js"></script> | ||
--> | ||
<script src="lib/angular/angular.js"></script> | ||
<script src="js/app.js"></script> | ||
<script src="js/services.js"></script> | ||
<script src="js/controllers.js"></script> | ||
<script src="js/filters.js"></script> | ||
<script src="js/directives.js"></script> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
'use strict'; | ||
|
||
|
||
// Declare app level module which depends on filters, and services | ||
angular.module('myApp', ['myApp.filters', 'myApp.services', 'myApp.directives', 'myApp.controllers']). | ||
config(['$routeProvider', function($routeProvider) { | ||
$routeProvider.when('/view1', {templateUrl: 'partials/partial1.html', controller: 'MyCtrl1'}); | ||
$routeProvider.when('/view2', {templateUrl: 'partials/partial2.html', controller: 'MyCtrl2'}); | ||
$routeProvider.otherwise({redirectTo: '/view1'}); | ||
}]); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
'use strict'; | ||
|
||
/* Controllers */ | ||
|
||
angular.module('myApp.controllers', []). | ||
controller('MyCtrl1', [function() { | ||
|
||
}]) | ||
.controller('MyCtrl2', [function() { | ||
|
||
}]); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
'use strict'; | ||
|
||
/* Directives */ | ||
|
||
|
||
angular.module('myApp.directives', []). | ||
directive('appVersion', ['version', function(version) { | ||
return function(scope, elm, attrs) { | ||
elm.text(version); | ||
}; | ||
}]); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
'use strict'; | ||
|
||
/* Filters */ | ||
|
||
angular.module('myApp.filters', []). | ||
filter('interpolate', ['version', function(version) { | ||
return function(text) { | ||
return String(text).replace(/\%VERSION\%/mg, version); | ||
} | ||
}]); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
'use strict'; | ||
|
||
/* Services */ | ||
|
||
|
||
// Demonstrate how to register services | ||
// In this case it is a simple value service. | ||
angular.module('myApp.services', []). | ||
value('version', '0.1'); |
Oops, something went wrong.