1 | ![Module](https://img.shields.io/badge/%40platform-hyperdb.electron-%23EA4E7E.svg)
|
2 | [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
|
3 | [![NPM](https://img.shields.io/npm/v/@platform/hyperdb.electron.svg?colorB=blue&style=flat)](https://www.npmjs.com/package/@platform/hyperdb.electron)
|
4 | ![banner](https://user-images.githubusercontent.com/185555/56085485-33496a00-5e98-11e9-8ec8-992d5687a955.png)
|
5 |
|
6 | Safe [IPC](https://electronjs.org/docs/api/ipc-renderer) wrapper for working with [@platform/hyperdb](../hyperdb) in [electron](https://electronjs.org).
|
7 |
|
8 |
|
9 | ## Setup
|
10 |
|
11 | yarn add @platform/hyperdb.electron
|
12 |
|
13 | See the [`/test`](./test) folder for example configuration and usage samples in a [uiharness](https://uiharness.com).
|
14 |
|
15 | yarn ui start
|
16 |
|
17 | <p> <p><p> <p>
|
18 |
|
19 | ![diagram](https://user-images.githubusercontent.com/185555/56322016-03fa6c00-61bc-11e9-8aa3-2a365e4fd3cb.png)
|
20 |
|
21 |
|
22 | <p> <p>
|
23 |
|
24 | ## Building for Electron
|
25 | Run the `rebuild` script that fixes `dist` build issues with `sodium-native`. See [issue #5851](https://github.com/electron/electron/issues/5851).
|
26 |
|
27 | In your `package.json`:
|
28 |
|
29 | ```json
|
30 | {
|
31 | "scripts": {
|
32 | "rebuild": "platform.electron rebuild"
|
33 | }
|
34 | }
|
35 | ```
|
36 | You may require `libtool` to complete as well as the XCode command-line tools that contains `gcc`:
|
37 |
|
38 | ```
|
39 | brew install libtool
|
40 | ```
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 | <p> <p><p> <p>
|
47 |
|
48 | ## See Also
|
49 |
|
50 | - @platform/[hyperdb.electron](../hyperdb)
|
51 | - @platform/[hyperdb.types](../hyperdb.types)
|
52 | - @platform/[hyperdb.tools](../hyperdb.tools)
|
53 | - @platform/[hyperdb.electron](../hyperdb.electron)
|