https://github.com/dcspark/urbit-dashboard

Urbit Web App which allows users to easily view key stats and have administrative control over their Urbit ship straight from the web browser.
https://github.com/dcspark/urbit-dashboard

airlock dashboard urbit urbit-visor

Last synced: about 1 month ago
JSON representation

Urbit Web App which allows users to easily view key stats and have administrative control over their Urbit ship straight from the web browser.

• Host: GitHub
• URL: https://github.com/dcspark/urbit-dashboard
• Owner: dcSpark
• License: mit
• Created: 2021-08-16T23:04:11.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-26T11:53:22.000Z (over 2 years ago)
• Last Synced: 2024-04-16T08:55:27.463Z (9 months ago)
• Topics: airlock, dashboard, urbit, urbit-visor
• Language: JavaScript
• Homepage:
• Size: 3.78 MB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  Urbit Dashboard



Urbit Dashboard is an Urbit Web App which allows users to easily view key stats and have administrative control over their Urbit ship straight from the web browser. An an Urbit Web App, Urbit Dashboard relies on Urbit Visor to interact with your Urbit ship and the rest of the network itself.




## Getting Started

The fastest way to get started using Urbit Dashboard is by visiting [https://urbitdashboard.com/](https://urbitdashboard.com/)

## Compile It Yourself

To get started first clone this repo:

```

$ git clone https://github.com/dcSpark/urbit-dashboard

```

Once you have done that simply use `npm` to compile it yourself:

```

$ cd urbit-dashboard

$ npm install

$ npm start

```

## For Developers

Urbit Dashboard is the premier example of how developers can interact with the Urbit Visor API to build full fledged web apps.

The dashboard provides examples for how to:

- Create a login/connection experience for end users

- Ask Urbit Visor for permissions

- Scry

- Execute threads

- Issue pokes

- Start subscriptions

- Query ship for initial state

- Support hot-swapping

- And more

Take a look in the `src` folder to see how all of the above use cases are implemented.