Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

update readme

  • Loading branch information...
commit 2f02181f32bd5c5012fc5b5c7a0bdc976a24f788 1 parent f2fbedb
Igor Minar authored vojtajina committed

Showing 1 changed file with 9 additions and 137 deletions. Show diff stats Hide diff stats

  1. +9 137 README.md
146 README.md
Source Rendered
... ... @@ -1,143 +1,15 @@
1   -# angular-seed — the seed for AngularJS apps
  1 +# FoodMe App — a workshop app built with AngularJS
2 2
3   -This project is an application skeleton for a typical [AngularJS](http://angularjs.org/) web app.
4   -You can use it to quickly bootstrap your angular webapp projects and dev environment for these
5   -projects.
  3 +Simplified meal ordering app for local restaurants built with AngularJS
  4 +and node.js backend.
6 5
7   -The seed contains AngularJS libraries, test libraries and a bunch of scripts all preconfigured for
8   -instant web development gratification. Just clone the repo (or download the zip/tarball), start up
9   -our (or yours) webserver and you are ready to develop and test your application.
  6 +Check out this doc for more info about the app: http://goo.gl/Xa0Ea
10 7
11   -The seed app doesn't do much, just shows how to wire two controllers and views together. You can
12   -check it out by opening app/index.html in your browser (might not work file `file://` scheme in
13   -certain browsers, see note below).
  8 +Also check out the commit history to see how the app was built piece by piece:
14 9
15   -_Note: While angular is client-side-only technology and it's possible to create angular webapps that
16   -don't require a backend server at all, we recommend hosting the project files using a local
17   -webserver during development to avoid issues with security restrictions (sandbox) in browsers. The
18   -sandbox implementation varies between browsers, but quite often prevents things like cookies, xhr,
19   -etc to function properly when an html page is opened via `file://` scheme instead of `http://`._
  10 +https://github.com/IgorMinar/foodme/commits/master
20 11
  12 +---
21 13
22   -## How to use angular-seed
23   -
24   -Clone the angular-seed repository and start hacking...
25   -
26   -
27   -### Running the app during development
28   -
29   -You can pick one of these options:
30   -
31   -* serve this repository with your webserver
32   -* install node.js and run `scripts/web-server.js`
33   -
34   -Then navigate your browser to `http://localhost:<port>/app/index.html` to see the app running in
35   -your browser.
36   -
37   -
38   -### Running the app in production
39   -
40   -This really depends on how complex is your app and the overall infrastructure of your system, but
41   -the general rule is that all you need in production are all the files under the `app/` directory.
42   -Everything else should be omitted.
43   -
44   -Angular apps are really just a bunch of static html, css and js files that just need to be hosted
45   -somewhere, where they can be accessed by browsers.
46   -
47   -If your Angular app is talking to the backend server via xhr or other means, you need to figure
48   -out what is the best way to host the static files to comply with the same origin policy if
49   -applicable. Usually this is done by hosting the files by the backend server or through
50   -reverse-proxying the backend server(s) and a webserver(s).
51   -
52   -
53   -### Running unit tests
54   -
55   -We recommend using [jasmine](http://pivotal.github.com/jasmine/) and
56   -[Testacular](http://vojtajina.github.com/testacular/) for your unit tests/specs, but you are free
57   -to use whatever works for you.
58   -
59   -Requires [node.js](http://nodejs.org/), Testacular (`sudo npm install -g testacular`) and a local
60   -or remote browser.
61   -
62   -* start `scripts/test.sh` (on windows: `scripts\test.bat`)
63   - * a browser will start and connect to the Testacular server (Chrome is default browser, others can be captured by loading the same url as the one in Chrome or by changing the `config/testacular.conf.js` file)
64   -* to run or re-run tests just change any of your source or test javascript files
65   -
66   -
67   -### End to end testing
68   -
69   -Angular ships with a baked-in end-to-end test runner that understands angular, your app and allows
70   -you to write your tests with jasmine-like BDD syntax.
71   -
72   -Requires a webserver, node.js + `./scripts/web-server.js` or your backend server that hosts the angular static files.
73   -
74   -Check out the
75   -[end-to-end runner's documentation](http://docs.angularjs.org/guide/dev_guide.e2e-testing) for more
76   -info.
77   -
78   -* create your end-to-end tests in `test/e2e/scenarios.js`
79   -* serve your project directory with your http/backend server or node.js + `scripts/web-server.js`
80   -* to run do one of:
81   - * open `http://localhost:port/test/e2e/runner.html` in your browser
82   - * run the tests from console with [Testacular](vojtajina.github.com/testacular) via
83   - `scripts/e2e-test.sh` or `script/e2e-test.bat`
84   -
85   -
86   -### Receiving updates from upstream
87   -
88   -When we upgrade angular-seed's repo with newer angular or testing library code, you can just
89   -fetch the changes and merge them into your project with git.
90   -
91   -
92   -## Directory Layout
93   -
94   - app/ --> all of the files to be used in production
95   - css/ --> css files
96   - app.css --> default stylesheet
97   - img/ --> image files
98   - index.html --> app layout file (the main html template file of the app)
99   - index-async.html --> just like index.html, but loads js files asynchronously
100   - js/ --> javascript files
101   - app.js --> application
102   - controllers.js --> application controllers
103   - directives.js --> application directives
104   - filters.js --> custom angular filters
105   - services.js --> custom angular services
106   - lib/ --> angular and 3rd party javascript libraries
107   - angular/
108   - angular.js --> the latest angular js
109   - angular.min.js --> the latest minified angular js
110   - angular-*.js --> angular add-on modules
111   - version.txt --> version number
112   - partials/ --> angular view partials (partial html templates)
113   - partial1.html
114   - partial2.html
115   -
116   - config/testacular.conf.js --> config file for running unit tests with Testacular
117   - config/testacular-e2e.conf.js --> config file for running e2e tests with Testacular
118   -
119   - scripts/ --> handy shell/js/ruby scripts
120   - e2e-test.sh --> runs end-to-end tests with Testacular (*nix)
121   - e2e-test.bat --> runs end-to-end tests with Testacular (windows)
122   - test.bat --> autotests unit tests with Testacular (windows)
123   - test.sh --> autotests unit tests with Testacular (*nix)
124   - web-server.js --> simple development webserver based on node.js
125   -
126   - test/ --> test source files and libraries
127   - e2e/ -->
128   - runner.html --> end-to-end test runner (open in your browser to run)
129   - scenarios.js --> end-to-end specs
130   - lib/
131   - angular/ --> angular testing libraries
132   - angular-mocks.js --> mocks that replace certain angular services in tests
133   - angular-scenario.js --> angular's scenario (end-to-end) test runner library
134   - version.txt --> version file
135   - unit/ --> unit level specs/tests
136   - controllersSpec.js --> specs for controllers
137   - directivessSpec.js --> specs for directives
138   - filtersSpec.js --> specs for filters
139   - servicesSpec.js --> specs for services
140   -
141   -## Contact
142   -
143   -For more information on AngularJS please check out http://angularjs.org/
  14 +The app is build on top of [angular-seed](http://github.com/angular/angular-seed),
  15 +check out seed's README to understand what the scripts under `scripts/` are doing.

0 comments on commit 2f02181

Please sign in to comment.
Something went wrong with that request. Please try again.