Skip to content
Newer
Older
100644 132 lines (74 sloc) 3.47 KB
25a1639 @vmx Added README
vmx authored May 9, 2012
1 Welcome to the world of GeoCouch
2 ================================
3
4 GeoCouch is a spatial extension for Couchbase and Apache CouchDB.
5
6
e120c3e @vmx CBD-697: Prepare build system for Apache CouchDB
vmx authored Nov 30, 2012
7 For Couchbase
8 -------------
9
10 ### Checkout the code
25a1639 @vmx Added README
vmx authored May 9, 2012
11
e120c3e @vmx CBD-697: Prepare build system for Apache CouchDB
vmx authored Nov 30, 2012
12 Check the code out with repo:
25a1639 @vmx Added README
vmx authored May 9, 2012
13
14 mkdir newvtree
15 cd newvtree
16 repo init -u git://github.com/couchbase/manifest.git -m toy/toy-newvtree.xml
17 repo sync
18
19
e120c3e @vmx CBD-697: Prepare build system for Apache CouchDB
vmx authored Nov 30, 2012
20 ### Build instructions
25a1639 @vmx Added README
vmx authored May 9, 2012
21
22 Make sure you have built CouchDB from source including `make dev`. So
23 go to your CouchDB directory and run:
24
25 ./bootstrap
26 ./configure
27 make dev
28
29 After that you can compile GeoCouch from within the GeoCouch directory:
30
e120c3e @vmx CBD-697: Prepare build system for Apache CouchDB
vmx authored Nov 30, 2012
31 COUCH_SRC=<path-to-couchdb-source>/src/couchdb make couchbase
25a1639 @vmx Added README
vmx authored May 9, 2012
32
33
e120c3e @vmx CBD-697: Prepare build system for Apache CouchDB
vmx authored Nov 30, 2012
34 ### Running tests
25a1639 @vmx Added README
vmx authored May 9, 2012
35
36 After you've followed the build instructions you can run the tests with
37
e120c3e @vmx CBD-697: Prepare build system for Apache CouchDB
vmx authored Nov 30, 2012
38 COUCH_SRC=<path-to-couchdb-source>/src/couchdb make couchbase-check
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
39
40
41 For Apache CouchDB
42 ------------------
43
44 This version of GeoCouch needs at least Apache CouchDB 1.3.x.
45
46
47 ### Checkout the code
48
49 First checkout the source code for Apache CouchDB into a directory that will
c1a9ad2 @vmx MB-100: Fix README's Markdown
vmx authored Dec 11, 2012
50 be referred to as `<path-to-couchdb-source>`.
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
51
52 Then checkout the GeoCouch source:
53
54 git clone -b newvtree https://github.com/couchbase/geocouch.git
55
56 There's a new directory called `geocouch` created. From now on this directory
c1a9ad2 @vmx MB-100: Fix README's Markdown
vmx authored Dec 11, 2012
57 will be referred to as `<path-to-geocouch-source>`.
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
58
59
60 ### Build instructions
61
62 Make sure you have built Apache CouchDB from source including `make dev`. So
c1a9ad2 @vmx MB-100: Fix README's Markdown
vmx authored Dec 11, 2012
63 go to your `<path-to-couchdb-source>` and run:
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
64
65 ./bootstrap
66 ./configure
67 make dev
68
69 After that you can compile GeoCouch from within the GeoCouch directory:
70
71 COUCH_SRC=<path-to-couchdb-source>/src/couchdb make couchdb
72
73 Now copy the configuration file into your Apache CouchDB directory:
74
5e15db2 @vmx MB-7013: Update Apache CouchDB section in the README
vmx authored Jan 7, 2016
75 cp gc-couchdb/etc/couchdb/default.d/geocouch.ini <path-to-couchdb-source>/etc/couchdb/default.d/
76
77
78 ### Running Apache CouchDB
79
80 Apache CouchDB needs the compiled geocouch in the include path. You can either copy `gc-couchdb` and `vtree` into `<path-to-couchdb-source>/src/` or set the `ERL_LIBS` environment variable to the GeoCouch root directory.
81
82c6a84 @vmx MB-7013: Fix Markdown syntax of the README.
vmx authored Feb 15, 2016
82 cd <path-to-couchdb-source>
83 ERL_LIBS="<path-to-geocouch-source>" ./utils/run
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
84
85
86 ### Running tests
87
88 After you've followed the build instructions you can run the tests with
89
90 COUCH_SRC=<path-to-couchdb-source>/src/couchdb make couchdb-check
91
92 In order to run the JavaScript based tests, you need to start Apache CouchDB first:
93
94 cd <path-to-couchdb-source>
95 ERL_LIBS="<path-to-geocouch-source>" ./utils/run
96
97 The tests can either be run from the command line or the browser.
98
99
100 #### From command line
101
102 From the command line the easiest way is to use the supplied runner script.
c1a9ad2 @vmx MB-100: Fix README's Markdown
vmx authored Dec 11, 2012
103 From within the `<path-to-geocouch-source>`:
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
104
105 cd gc-couchdb
106 ./utils/runjstests.sh <path-to-couchdb-source>/test/javascript/run ./share/www/script/test
107
108
109 #### From browser
110
111 To run it from the browser first copy the JavaScript tests into the same directory as the other Apache CouchDB tests:
112
c1a9ad2 @vmx MB-100: Fix README's Markdown
vmx authored Dec 11, 2012
113 cp <path-to-geocouch-source>/gc-couchdb/share/www/script/test/* <path-to-couchdb-source>/share/www/script/test/
70c8602 @vmx MB-7013: Make the new vtree work with Apache CouchDB
vmx authored Dec 3, 2012
114
115 Then add the tests to `<path-to-couchdb-source>/share/www/script/couch_tests.js`
116
117 loadTest("spatial.js");
118 loadTest("list_spatial.js");
119 loadTest("etags_spatial.js");
120 loadTest("multiple_spatial_rows.js");
121 loadTest("spatial_compaction.js");
122 loadTest("spatial_design_docs.js");
123 loadTest("spatial_bugfixes.js");
124 loadTest("spatial_offsets.js");
3d06383 @vmx MB-7013: Add support for multidimensional indexes/queries
vmx authored Dec 4, 2012
125 loadTest("spatial_range.js");
918bd0e @vmx MB-12007: Add proper license
vmx authored Aug 19, 2014
126
127
128 License
129 -------
130
131 GeoCouch is licensed under the Apache License 2.0.
Something went wrong with that request. Please try again.