UNPKG

3.14 kBMarkdownView Raw
1# ewd-document-store
2
3[![Build Status](https://travis-ci.org/robtweed/ewd-document-store.svg?branch=master)](https://travis-ci.org/robtweed/ewd-document-store) [![Coverage Status](https://coveralls.io/repos/github/robtweed/ewd-document-store/badge.svg?branch=master)](https://coveralls.io/github/robtweed/ewd-document-store?branch=master)
4
5Persistent JavaScript Objects and a fine-grained Document Database, using a Global Storage database
6
7Rob Tweed <rtweed@mgateway.com>
87 March 2016, M/Gateway Developments Ltd [http://www.mgateway.com](http://www.mgateway.com)
9
10Twitter: [@rtweed](https://twitter.com/rtweed)
11
12Google Group for discussions, support, advice etc: [http://groups.google.co.uk/group/enterprise-web-developer-community](http://groups.google.co.uk/group/enterprise-web-developer-community)
13
14
15## Installation
16
17 npm install ewd-document-store
18
19
20## Using ewd-document-store
21
22 - For full details of ewd-document-store see: [http://gradvs1.mgateway.com/download/ewd-document-store.pdf](http://gradvs1.mgateway.com/download/ewd-document-store.pdf)
23 - For a complete, working examples, refer to [examples](https://github.com/robtweed/ewd-document-store-examples) that uses `ewd-document-store`
24
25
26## Integration tests
27
28 * You must have [InterSystem Caché](http://www.intersystems.com/our-products/cache/cache-overview/) installed
29 * You must have `cache.node` in npm global registy. Read [Installation](http://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=BXJS_intro#BXJS_intro_install) to get more details
30 * Run `npm link cache.node` before running integration tests
31 * You may need to run this as sudo because of permissions
32
33
34## License
35
36 Copyright (c) 2013-17 M/Gateway Developments Ltd,
37 Reigate, Surrey UK.
38 All rights reserved.
39
40 http://www.mgateway.com
41 Email: rtweed@mgateway.com
42
43
44 Licensed under the Apache License, Version 2.0 (the "License");
45 you may not use this file except in compliance with the License.
46 You may obtain a copy of the License at
47
48 http://www.apache.org/licenses/LICENSE-2.0
49
50 Unless required by applicable law or agreed to in writing, software
51 distributed under the License is distributed on an "AS IS" BASIS,
52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
53 See the License for the specific language governing permissions and
54 limitations under the License.