@urbit/create-near-app

Create Urbit's NEAR dApp

Quickly build Urbit-compatible NEAR Blockchain Operating System (BOS) gateway.

Prerequisites

• Make sure you have a current version of Node.js installed – we are targeting versions 18 for frontend/gateways.
• Have Urbit environment setup and running Urbit "fakeship".

Getting Started

To create a new Urbit's NEAR dApp run this and follow interactive prompts:

npx [e-mail]:urbit/create-near-app.git

Follow the instructions in the README.md in the project you just created! 🚀

We strongly recommend you to follow our creating your first Urbit-compatible NEAR BOS gateway if you are new to Urbit or isn’t so familiar with BOS.

Getting Help

Check out our documentation or chat with us in our NEAR group. We'd love to hear from you!

Deploy urbit/create-near-app on Urbit

To deploy your BOS gateway on Urbit, you’ll need to create a binary blob of the frontend code. After that, you can upload your gateway to the NEAR Gateways app for users on Urbit to use and install for themselves.

• pnpm run build

• Use the fakeship’s -make-glob functionality to make the glob.

• Upload your frontend glob to your S3 bucket. If you have the Silo app on your ship, it’s easy to do it in there.

• Once your glob is uploaded, go to NEAR Gateways and click the “Upload Gateway” card. Enter your BOS gateway’s name, glob url, and description in the form that shows up.

• Click “publish gateway” and wait for your gateway to upload. This could take some time, but you don’t have to keep the window open while you wait; your ship is processing the glob in the background.

Deploy Urbit aware component

If you want to deploy components to the NEAR blockchain you’ll need a mainnet NEAR wallet. MyNearWallet is a popular choice.

If you don’t want to pay the small fee for a mainnet wallet, MyNearWallet will let you create one on their testnet

Once you have a wallet set up, use it to log in at NEAR Social or NEAR Social (testnet).

You can write and upload your components in the NEAR Social Editor.

The NEAR Social Editor does not currently recognize an Urbit object. You won’t be able to test Urbit methods in this editor. If the editor warns you about Urbit methods and you’ve tested them in your local gateway, you can safely ignore them.

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE and LICENSE-APACHE for details.