Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 2.61 KB

README.md

File metadata and controls

86 lines (62 loc) · 2.61 KB
Raw

Realm app

An electron app that serves as a GUI for the Realm experience and Urbit. The intention is for this app to be used fullscreen and as a replacement for your old school OS. Once you open Realm, you will be in a new sovereign world where no megacorps can watch you.

Getting started

You should build the project from root with yarn so that all the libs build properly.

Start the app in dev mode with yarn start or npm run start.

Developing apps within Realm

You can think of Realm like a web browser. You can hot reload apps you are actively developing through Realm by adding some metadata to src/app.dev.json.

You can add a record for your development application in the following format:

{
  "ballot-dev": {
    "id": "ballot-dev",
    "title": "Ballot - Dev",
    "type": "dev",
    "color": "#cebef0",
    "icon": "https://lomder-librun.sfo3.digitaloceanspaces.com/tiles/ballot-app-tile.svg",
    "config": {
      "size": [6, 8],
      "showTitlebar": true,
      "titlebarBorder": false
    },
    "web": {
      "url": "http://localhost:3000/apps/ballot/"
    }
  }
}

Architecture

The project is structured with the goal of having a seperate process sync data from your Urbit server and being an offline cache of your Urbit ship state.


    ____________          _____________          _________________
   |            |        |             |        |                |
   |  Renderer  | ------ |    Main     | ------ |   Background   |
   |____________|        |_____________|        |________________|
                                |
                                |
                          ____________
                         |            |
                         |     OS     |
                         |____________|
  • /renderer is the GUI layer.
  • /main is the main electron process
  • /os is the core background process libs for syncing state and managing data.
  • /background is the background process logic, starts a tray icon for Realm.

Packaging for release

Running the below command will place the build output at /release/build.

yarn package

If you include DEBUG_PROD=true you can open dev tools and check for errors.

npx cross-env DEBUG_PROD=true yarn package

SqlCipher connection through Datagrip or DB tool

We use better-sqlite3-multiple-ciphers to use encrypted better-sqlite3

Set up a custom driver for datagrip here:

https://github.com/Willena/sqlite-jdbc-crypt/releases

Guide: https://intellij-support.jetbrains.com/hc/en-us/community/posts/360007633799-How-to-open-SQLCipher-passwrd-protected-file-in-Datagrip

--