Repository files navigation

All examples in this repository are obsolete as of late 2020 (with most in /wip/ obsolete even earlier). Please consult thedeveloper's guide or community projects likeUrbit Lab.

This is an open repository for Urbit example code.

There are generators (short Dojo commands), libraries (to be loaded intoDojo), Landscape and Gall applications, and marks and structures thatthese example appilcations use.

Give these a try by following the installation instructions below, andperuse the list.

First, you'll need a running urbit.InstallUrbit, thenboot a ship.

For development purposes,fake shipsare best. If you need live network connectivity, comets are recommended.

Some applications are working examples of Landscape applications with specifictypes of functionality you can play around with.Others are generators, libraries for Dojo, and more.

The top folder directory is listed per example; each example has folders youcopy into your Urbit ship (eg. /app, /lib, /mar). Once you've copied theexample into your ship,|commit %home (or whatever%desk you're using)to update your ship filesystem.

Landscape tiles also use theReact framework and requirecompilation if you want to change them -- find their source in the /src folder,npm install their dependencies, change the Urbit ship location in the.urbitrc file to your ship location, andnpm run serve.

If you just want to try out the Landscape tile examples, then all you needto do is copy the other folders into your ship.

You'll find Landscape running onhttp://localhost:PORT, PORT being 80, 8080, 8081,and so on, depending on your operating system's free ports; see your ship's boot messagefor a notification as to what port HTTP is available on. If you haven't usedLandscape before, you'll need to enter+code on your ship to get the passwordto authenticate yourself with on the Landscape interface.

See also theUrbit documentationfor more information.

Each example has more information in its directory -- click an example belowto learn more about it.

The number one goal for this repository is for it to be fun! People are alwaysaround onChat. Help each other out, and don't hesitate ifyou have an idea for a contribution. We'd love to make this both a learningresource and a record of what people in the community are coming up with.

Give us feedbackvia email afteryou've played around with these for a little bit. Let us know about your ideas,requests, and/or problems and we'll try and get back to you quickly. Pullrequests are more than welcome.