https://github.com/tomholford/denurbit

An Urbit API client implemented in Deno
https://github.com/tomholford/denurbit

Last synced: 2 months ago
JSON representation

An Urbit API client implemented in Deno

• Host: GitHub
• URL: https://github.com/tomholford/denurbit
• Owner: tomholford
• Created: 2021-02-10T09:06:51.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-23T20:37:17.000Z (almost 4 years ago)
• Last Synced: 2024-08-03T01:15:19.749Z (5 months ago)
• Language: TypeScript
• Size: 14.6 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-urbit - Deno

README

        
# denurbit

[![awesome urbit badge](https://img.shields.io/badge/~-awesome%20urbit-lightgrey)](https://github.com/urbit/awesome-urbit)

An [Urbit](https://urbit.org/) API client implemented in

[Deno](https://deno.land/).

## Usage

```ts

import { Config, Ship } from 'https://deno.land/x/denurbit';

config = new Config(config_file: 'my_moon.json');

ship = new Ship(config);

ship.isAuthed

# > false

ship.authenticate

ship.isAuthed

# > true

```

## Test

Tests expect [a fake development ship](https://urbit.org/docs/development/environment/#creating-a-development-ship) to be running at `http://localost:80`

```sh

./bin/tests

```

## Roadmap

- [x] Config

- [ ] HTTP API Integration (*in progress*)

  - [x] Authentication

  - [ ] Open Channel

  - [ ] Close Channel

  - [ ] Send Message to Channel

  - [ ] React to Message from Channel

- [ ] Channel

- [ ] Message

- [ ] `graph-store` integration

- [ ] `group-store` integration

- [ ] `metadata-store` integration