Giter Club home page Giter Club logo

bouncer's Introduction

bouncer

A dev tool to streamline Urbit app development. bouncer connects to a running ship (e.g, a fake ship or locally running moon) and runs a customizable script to merge, mount, rsync, commit, and install (a common workflow for app development).

Requirements

  • Ruby 3+
  • bundler (gem install bundler)
  • a fresh Urbit fake ship (currently assumes ~zod)

Setup

  1. Check out this repo
  2. Run bundle to install the Ruby dependencies
  3. Create a copy of config.yml and add your own script and ENV vars. See ./apps/landscape/config.yml for an example

Usage

For a quick demo, start a new fake ~zod and then:

bin/bounce

To use a custom config:

bin/bounce -c ./apps/landscape/config.yml

Or for a ship besides ~zod running on another loopback port (ie, running multiple ships):

bin/bounce -c ./apps/landscape/config.yml -s net -p 12322

The custom config syntax is documented in config.yml.

To find the loopback port, check the fake ship output for the following line:

http: loopback live on http://localhost:12322

Example

Check out the landscape-apps repo for an example of how bouncer is used in production at Tlon.

TODO

  • automated removal of stale pier / creation of new pier (for now, run ./create.sh manually)

bouncer's People

Contributors

tomholford avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

bouncer's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.