Merge branch 'master' of github.com:dpavlin/angular-mojolicious
[angular-mojolicious.git] / README
1 REST JSONP server using mojolicious for <angular/>
2
3
4 <angular/>: Complex web apps made simple
5 http://angularjs.org/
6
7
8 mojolicious: the web in the box!
9 http://mojolicious.org/
10
11
12 This is my attempt to implement REST API described at:
13
14 http://docs.getangular.com/REST.Basic
15
16 using CouchDB HTTP view API
17
18 http://wiki.apache.org/couchdb/HTTP_view_API
19
20 to provide storage for experimenting with local datasets using angular.
21
22
23 At it's current stage it provides support for angular $resource get, query and $save
24
25 http://angularjs.org/Service:$resource
26
27
28 Server also supports replication using same API which can be triggered with
29
30  http://localhost:3000/_replicate?from=http://dpavlin.getangular.com/data/conference/
31
32 Replication is currently good only for initial import of data since it doesn't
33 support incremental replication and dies if data is allready present.
34
35
36 Installation:
37
38         git submodule init
39         git submodule update
40
41 Optionally build angular to get single file download
42
43         cd public/angular
44         rake compile
45         cd -
46
47 Start it with:
48
49         ./angular-server.pl daemon --reload  
50
51
52 Angular examples available:
53
54 - template/Cookbook - examples from wiki working against github version of angular
55 - template/conferece - conference submission example using mojolicious REST API server
56
57
58 Planned features:
59
60 - run queries against data using REST API (currently only simple get is supported)