git.iko.soy/urbit.org
on c19bc7a help sign in
urbit.org/docs/about/source.udon
88 lines 3.6 kB history raw
1:- :~ navhome/'/docs/'
2 navuptwo/'true'
3 next/'true'
4 sort/'2'
5 title/'Source code'
6 ==
7;>
9# Source code overview
11We host all our source code on GitHub at [github.com/urbit](https://github.com/urbit).
13Since there's quite a number of repos, we'll talk about a few of the most important ones here:
15;ul(class "list spaced")
16 ;li
17 ;h1
18 ;a/"https://github.com/urbit/urbit"
19 ;code: urbit/urbit
20 ==
21 ==
22 This is the main Urbit repo. It contains the Urbit interpreter (all of the C code) and is the main entry point if you're going to build from source.
23 ==
24 ;li
25 ;h1
26 ;a/"https://github.com/urbit/arvo"
27 ;code: urbit/arvo
28 ==
29 ==
30 Arvo is the Urbit operating system (written in Hoon). When you boot your Urbit, you get this over the air. The source code is kept here, and you'll need it if you want to do any heavy development work.
31 ==
32 ;li
33 ;h1
34 ;a/"https://github.com/urbit/docs"
35 ;code: urbit/docs
36 ==
37 ==
38 Interesting in working on Urbit documentation? This repository is where all the collaboration happens. The docs themselves are just markdown files hosted on a live ship.
39 ==
40 ;li
41 ;h1
42 ;a/"https://github.com/urbit/urbit.org"
43 ;code: urbit/urbit.org
44 ==
45 ==
46 This is where the source code for urbit.org lives. Like the docs, the urbit.org website is just a collection of a few markdown files rendered by Tree, the Urbit web publishing system.
47 ==
48 ;li
49 ;h1
50 ;a/"https://github.com/urbit/base-css"
51 ;code: urbit/base-css
52 ==
53 ==
54 We're working on a new Urbit style guide for urbit.org, the docs and Urbit web apps. If you're into visual design or are a CSS fanatic, jump in here.
55 ==
56 ;li
57 ;h1
58 ;a/"https://github.com/urbit/constitution"
59 ;code: urbit/constitution
60 ==
61 ==
62 We're [bootstrapping Urbit from Ethereum](https://urbit.org/blog/2017.9-eth/). This means formally defining the Urbit governance model and public-key infrastructure formally in a simple smart contract deployed on the Ethereum blockchain. If you're into Solidity, or just want to see how this works, check out this repo. Currently getting audited.
63 ==
64 ;li
65 ;h1
66 ;a/"https://github.com/urbit/etherwallet"
67 ;code: urbit/etherwallet
68 ==
69 ==
70 Urbit will soon need a secure, robust frontend interface for buying and selling Urbit address space and interacting directly with the Urbit constitution smart contract. We decided to fork MyEtherWallet, which already has strong security and support for things like multisig and hardware wallet, and modify it to support Urbit. Dive in!
71 ==
72 ;li
73 ;h1
74 ;a/"https://github.com/urbit/tree"
75 ;code: urbit/tree
76 ==
77 ==
78 Tree is the main Urbit web interface written as a React/Flux app in CoffeeScript. We're working on porting this to ES6 and simplifying the architecture generally. If you're into frontend frameworks and web apps, reach out to us and we'll help you get started.
79 ==
80 ;li
81 ;h1
82 ;a/"https://github.com/urbit/talk"
83 ;code: urbit/talk
84 ==
85 ==
86 The main web interface for Urbit's distributed chat and notifications protocol. Currently, like Tree, a simple React/Flux app written in CoffeeScript. With lots of changes happening to the Talk Hoon backend app in the coming releases, our frontend Talk interface will need a lot of development and design work. We've also started the process of porting this to ES6. Ask us how you can start helping out!
87 ==
88==