git.iko.soy/urbit.org
on 6699b4c help sign in
urbit.org/content/using/develop.md
114 lines 8.1 kB history raw
1+++
2title = "Developer's Guide"
3description = "How to get started developing on Urbit."
4weight = 3
5template = "page_indiced.html"
6aliases = ["/docs/using/creating-a-development-ship/", "/docs/getting-started/contributing"]
7+++
9You can develop on Urbit in three ways:
11- [Applications on Urbit](#api), which use Urbit as the back-end to store data and communicate with others
12- [Urbit Applications](#application), which are written in [Hoon](/docs/glossary/hoon/), and run as part of Urbit
13- [Urbit Core](#core)
15This guide will start by getting you set up to run an Urbit ship, and then tell you everything you need to know to do either.
17### Setting up your environment
19We assume you’ve gotten a basic introduction to Urbit. If you haven’t, read the [Understanding Urbit](@/understanding-urbit/_index.md) series.
21Once you’re ready, you can get started on the network right away and take some first steps, without acquiring an identity, by [creating a comet](@/using/install.md#comet).
23When developing, however, we recommend [booting a development ship](#creating-a-development-ship) and working locally -- you may need to make changes that could, in the wrong hands, destroy the ship’s environment, and it’s best to do so in a safe, separate place.
25## Applications on Urbit {#api}
27Urbit ships with its own set of apps written in its own language, Hoon. However it is also meant to integrate with applications written in other languages via an API. The clearest example of an application for Urbit is Landscape, the default client. Although it does currently ship with Urbit, its front-end is a separate piece of software that uses the Urbit API to interact with an Urbit ship. back. You can create your own application that uses Urbit to store data and interact with other Urbit ships without writing any Hoon code thanks to this API. This could be a chat client, a writing app, a game, or anything else.
29To get started quickly with the language of your choice, see the following libraries:
31 - [Python](https://github.com/baudtack/urlock-py) (Stable)
32 - [Haskell](https://github.com/bsima/urbit-airlock) (Under active development)
33 - [JavaScript](https://www.npmjs.com/package/urbit) (Under active development)
34 - Go (Pending release)
36[View details about using the API or creating your own implementation here.](/using/develop/integrating-api/)
38## Urbit Applications {#application}
40Urbit applications are still young, but can be fun to experiment with.
42When creating user applications on Urbit, you aren’t tied to any particular user interface. They can work without providing a response to the user, or by printing to the Dojo, or with an interface in Landscape, which uses [Eyre](@/docs/tutorials/arvo/eyre.md) (the Arvo vane that serves HTTP to serve a React-based interface to the application through a web browser).
44When writing applications, you will often make use of [Gall](@/docs/tutorials/hoon/hoon-school/gall.md), the Arvo vane that manages user applications.
46If you want to see examples of Urbit applications with common functionality requirements, you can see our [examples](https://github.com/urbit/examples) repository. If you want to get started building applications with a Landscape interface, check out our [create-landscape-app](https://github.com/urbit/create-landscape-app) repository.
48## Urbit Core {#core}
50Working on the core means improving the Urbit project itself, working with the existing community of Urbit developers. The kernel is much more stable, but generally more challenging from an engineering standpoint.
52Just arrived and unsure what to work on? An ideal way to get started is by experimenting with the system, talking to other developers, and reading (or [contributing to](https://github.com/urbit/docs)) the [documentation](/docs/).
54Prefer learning with an instructor? We also offer an online course that covers the basics of Urbit development called [Hoon School](@/community/hoonschool.md). If course-based learning works well for you, we recommend you sign up.
56The Urbit developer community congregates around [the urbit-dev mailing list](https://groups.google.com/a/urbit.org/forum/#!forum/dev), the `~bitbet-bolbel/urbit-community` group on Landscape, and [Urbit’s GitHub repository](https://github.com/urbit/urbit). It’s a good idea to sign up, see what people are talking about, and introduce yourself.
58Once you’re comfortable working with Urbit, check out the [project’s issues on GitHub](https://github.com/urbit/urbit/issues) or some of our [contribution bounties](https://grants.urbit.org/).
60If you’re looking for some guidance, need help, or would prefer direct communication for your ideas, you can also always reach out to us directly at [support@urbit.org](mailto:support@urbit.org).
62## Creating a development ship {#creating-a-development-ship}
64To do work with Hoon and with the system, we recommended using a "fake" ship -- one not connected to the network.
66Because such a ship has no presence on the network, you don't need an Azimuth identity for its purposes. You just need to have [installed our software](/using/install).
68To create a fake ship named `~zod`, run the command below. You can replace `zod` with any valid Urbit ship-name.
70```
71./urbit -F zod
72```
74Now you should see a block of boot messages, starting with the Urbit version number. Welcome!
76## Community tutorials {#community-tutorials}
78Here are some tutorials written by members of the Urbit community. Some are a little outdated, but they may still prove useful.
80- [Generators](https://github.com/joemfb/mardev/tree/master/docs/gen) by `~master-morzod`
81- [Urbit by Doing](https://github.com/Fang-/Urbit-By-Doing) by `~palfun-foslup`
82- [Learning Hoon](https://github.com/knubie/learning-hoon) by `@knubie`
83- [A Nock Interpreter](https://jtobin.io/nock) by `~nidsut-tomdun`
84- [Basic Hoonery](https://jtobin.io/basic-hoonery) by `~nidsut-tomdun`
86If you want to add something to the list, [shoot us an email](mailto:support@urbit.org) or make a pull request in the [docs repository](https://github.com/urbit/docs).
88## How else can I contribute? {#how}
90The Urbit project is a global community of developers, users, and fans. If you’re interested in getting involved, there’s space for you; you don’t have to be a developer to be a part of the project.
92### Running stars and galaxies
94There are two ways to participate in the Arvo network: as a user running a planet and as an infrastructure provider running a galaxy or a star.
96For planets, Urbit is a peer-to-peer network where users can interact with each other via Landscape, or using custom applications that anyone can write.
98Running a planet helps build Urbit’s community, surfaces bugs, and helps core developers improve Urbit under realistic conditions.
100Stars and galaxies, however, have additional responsibilities and play a role in peer discovery as well as star and planet distribution. You can think of stars and galaxies as similar to the DNS system in the modern Internet. Most users don’t know it exists, but without it, the web wouldn’t work at all.
102Running a reliable galaxy or star, and spawning stars and planets from them, are excellent ways to help bootstrap the Urbit network.
104If you’re interested in running a galaxy or star, you’ll be reliably providing peer discovery for your children just by running your node – and we’re doing our best to make this both easy and profitable. If you’re interested in this, see [Star and Galaxy Operations](@/using/operations/stars-and-galaxies.md).
106If you’re interested in distributing planets, read on.
108### Distribute points
110Want to get your friends and family into Urbit? Distribute planets using Bridge with a feature called **delegated sending**.
112Here’s how it works: any star can grant a number of invites to any of its child planets. Those planets can then send one-time-use invite codes via email to anyone of their choosing.
114For instructions on how to grant and send invites, check out [Using Bridge](@/using/operations/using-bridge.md).