content/develop.md · urbit.org

git.iko.soy/urbit.org

65 lines 4.7 kB history raw

1+++

2title = "Develop"

3template = "page_indiced.html"

4+++

6There are roughly two kinds of development on Urbit: core development and application development. Urbit applications are still young, but can be fun to experiment with. The kernel is much more stable, but generally more challenging from an engineering standpoint.

8This guide will start by getting you set up to run an Urbit ship, and then tell you everything you need to now do to either.

10### Setting up your environment

12We assume you’ve gotten a basic introduction to Urbit. If you haven’t, read the [Understanding Urbit](@/understanding-urbit/_index.md) series, or just jump ahead to the [Technical Overview](@/understanding-urbit/technical-overview.md).

14Once 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](@/operations.md#creating-a-comet).

16When 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.

18## Core development {#core}

20Working on the core means improving the Urbit project itself, working with the existing community of Urbit developers.

22Just 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/).

24Prefer learning with an instructor? We also offer an online course that covers the basics of Urbit development called [Hoon School](@/hoonschool.md). If course-based learning works well for you, we recommend you sign up.

26The Urbit developer community congregates around [the urbit-dev mailing list](https://groups.google.com/a/urbit.org/forum/#!forum/dev), the `~dopzod/urbit-help channel` 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.

28Once 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/).

30If 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).

32## Application development {#application}

34When 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/arvo/eyre.md) (the Arvo vane that serves HTTP to serve a React-based interface to the application through a web browser).

36When writing applications, you will often make use of [Gall](@/docs/hoon/hoon-tutorial/gall.md), the Arvo vane that manages user applications.

38If 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.

41## Creating a development ship {#creating-a-development-ship}

43To do work with Hoon and with the system, we recommended using a "fake" ship -- one not connected to the network.

45Because 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](/install).

47To create a fake ship named `~zod`, run the command below. You can replace `zod` with any valid Urbit ship-name.

49```

50urbit -F zod

51```

53Now you should see a block of boot messages, starting with the Urbit version number. Welcome!

55## Community tutorials {#community-tutorials}

57Here are some tutorials written by members of the Urbit community. Some are a little outdated, but they may still prove useful.

59- [Generators](https://github.com/joemfb/mardev/tree/master/docs/gen) by `~master-morzod`

60- [Urbit by Doing](https://github.com/Fang-/Urbit-By-Doing) by `~palfun-foslup`

61- [Learning Hoon](https://github.com/knubie/learning-hoon) by `@knubie`

62- [A Nock Interpreter](https://jtobin.io/nock) by `~nidsut-tomdun`

63- [Basic Hoonery](https://jtobin.io/basic-hoonery) by `~nidsut-tomdun`

65If 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).