README
Realm is a desktop environment for Urbit.
Directory structure
We use yarn workspace to manage the multiple modules.
Getting started
We use yarn workspaces to build all packages for Realm.
Dev setup
Follow
/.docs/DEV_SETUP.md
to setup fakeships and pull the Urbit submodule down into the Realm repo.Once these ships are created, you can then go to
/app/README.md
to get started with Realm.
Linux Installation Notes
Realm is distributed as an AppImage file. AppImages require FUSE version 2 to run. If you are running Ubuntu (>= 22.04), you will need to install fuse version 2. More information here:
https://github.com/AppImage/AppImageKit/wiki/FUSE
Build prerelease version
Building a prerelease will replace the .d.ts
files in all the /dist
folders, so make sure to run rm -rf ./**/dist
followed by yarn
in root when you want to run Realm in dev mode again.
Contributing
For frontend development, make sure to:
Install the ESLint extension in your editor of choice (VSCode link). The Prettier extension is not needed since we're using it as an ESLint plugin.
Configure your editor to format on save, so you don't have to run
yarn lint
manually (VSCode instruction).Follow the Frontend Style Guide.
Last updated