added instructions to put view using curl
[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 Replication of data between instances using angular REST API can be done with:
29
30         # create local CouchDB database
31         curl -X PUT http://localhost:5984/test
32
33         ./angular-replicate.pl \
34                 http://dpavlin.getangular.com/data/conference \
35                 http://localhost:3000/data/test
36
37 Replication is currently good only for initial import of data since it doesn't
38 support incremental replication and dies if data is allready present.
39
40
41 Installation:
42
43         git submodule init
44         git submodule update
45
46 Optionally build angular to get single file download
47
48         cd public/angular
49         rake compile
50         cd -
51
52 Start it with:
53
54         ./angular-server.pl daemon --reload  
55
56
57 Angular examples available:
58
59 - template/Cookbook - examples from wiki working against github version of angular
60 - template/conferece - conference submission example using mojolicious REST API server
61
62         curl -X PUT http://localhost:5984/conference/_design/symposium \
63                 -d @public/app/conference/_design/symposium
64
65
66 Planned features:
67
68 - run queries against data using REST API (currently only simple get is supported)