ilyakooo0/urbit
1
0
Fork 0
mirror of https://github.com/ilyakooo0/urbit.git synced 2024-09-21 15:38:59 +03:00
Code Issues Packages Projects Releases Wiki Activity
992b607e3c
urbit/pkg/npm/http-api
History
Tyler Brown Cifu Shuster 7a8b8ec718 npm/http-api: ignore build examples
2021-02-25 17:17:07 -08:00
..
example npm/http-api: ignore build examples 2021-02-25 17:17:07 -08:00
src http-api: changed eventsource tool 2021-02-24 19:58:32 -08:00
test added NPM packages 2021-01-26 21:45:18 -08:00
.gitignore ignore example js 2021-02-25 17:16:27 -08:00
package.json http-api: changed eventsource tool 2021-02-24 19:58:32 -08:00
README.md added NPM packages 2021-01-26 21:45:18 -08:00
tsconfig.json http-api: changed eventsource tool 2021-02-24 19:58:32 -08:00

README.md

Urbit Connector

This project allows you to connect to an Urbit ship via a JavaScript application.

Example

Check out the example directory for examples of how to use this code.

  1. Open example/index.html in your browser and follow the instructions there, or
  2. With a ship running in the same fashion as indicated in the file above, run node example/index.js

The code for either of these can be found in src/example/browser.js or src/example/node.js, depending on your context.

Design

This library is designed to be useful for node applications that communicate with an urbit running either on the local computer or on a remote one.

The majority of its methods are asynchronous and return Promises. This is due to the non-blocking nature of JavaScript. If used in a React app, response handlers should be bound with this to setState after a message is received.

NOTE

You must enable CORS requests on your urbit for this library to work in browser context. Use +cors-registry to see domains which have made requests to your urbit, and then approve the needed one, e.g. |cors-approve http://zod.arvo.network.