fund/README.md

%fund

A sovereign platform for peer-to-peer economic activity with on-chain settlement and trusted identity assessment of work completion.

Demos

Project Setup

Contribute Funds

Get Paid

Install

Within your Urbit ship's command-line interface, enter the following command(s):

|install ~tocwex %fund

Build/Develop

All commands assume that the current working directory is this repository's base directory and optionally use durploy to streamline various Urbit development workflows.

First-time Setup

Run the following commands to create a new fake ~zod with the %fund desk installed:

With durploy

curl -LO https://raw.githubusercontent.com/sidnym-ladrut/durploy/release/durploy
chmod u+x ./durploy
./durploy ship zod
# in a different terminal
./durploy desk zod fund ./desk/full/

Without durploy

urbit -F zod
|new-desk %fund
|mount %fund
|exit
rm -rI ./zod/fund/*
cp -RL ./desk/full/* ./zod/fund/
urbit ./zod
|commit %fund
|install our %fund

Development Workflows

Back-end Workflows

In order to continuously test back-end code changes as they're made, make sure you have your fake ~zod running in the background and execute the following commands:

With durploy

./durploy desk -w zod fund ./desk/full/

Without durploy

cp -fRL ./desk/full/ ./zod/fund/
# in the fakezod terminal
|commit %fund

Front-end Workflows

To view the front-end, simply open your development ship's web interface at the path /apps/fund; for a default fake ~zod, this will be:

http://127.0.0.1:8080/apps/fund

In order to continuously test front-end code changes as they're made, set up continuous back-end integration (as above) and log into the development ship from the web interface using the output of the dojo +code command as the password. Then, you should be able to edit the web files in ./desk/bare/web/fund/page and see them updated in your browser in real time.

Note that changes to library files (i.e. files outside the ./desk/bare/web/fund/page tree) will require prompting your fake ship to reload the dependent page files separately. The following commands can be run after library files are changed to achieve this aim, and also to revert the associated changes prior to commit:

find ./desk/bare/web/fund/page/ -type f -exec sh -c "echo '::  RELOAD' >> {}" \;

find ./desk/bare/web/fund/page/ -type f -exec sh -c "sed -i '/^::  RELOAD$/d' {}" \;

Deployment Workflow

Back-end Workflows

To generate a new full desk from the existing base desk:

./meta/exec/regen

To perform a versioned release:

./meta/exec/release X.Y.Z