https://github.com/urbit/pottery
Proof-of-concept clay visualizer
https://github.com/urbit/pottery
Last synced: about 1 year ago
JSON representation
Proof-of-concept clay visualizer
- Host: GitHub
- URL: https://github.com/urbit/pottery
- Owner: urbit
- Created: 2020-03-28T03:30:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-05T16:28:40.000Z (over 3 years ago)
- Last Synced: 2025-03-24T14:21:24.424Z (about 1 year ago)
- Language: JavaScript
- Size: 1.63 MB
- Stars: 23
- Watchers: 5
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Installation
Clone this repository, `npm install`, fill in your .urbitrc, and then run `npm run serve` to get started. Example .urbitrc:
```
module.exports = {
URBIT_PIERS: [
"/Users/dev/zod/home",
]
};
```
In order to run your application on your ship, you will need Urbit v.0.10.0 or higher. On your Urbit ship, if you haven't already, mount your pier to Unix with `|mount %`.
## Using
Once you're up and running, your tile lives in `tile/tile.js`, which uses [React](https://reactjs.org) to render itself -- you'll want a basic foothold with it first. When you make changes, the `urbit` directory will update with the compiled application and, if you're running `npm run serve`, it will automatically copy itself to your Urbit ship when you save your changes (more information on that below).
### `npm run build`
This builds your application and copies it into your Urbit ship's desk. In your Urbit `|commit %home` (or `%your-desk-name`) to synchronise your changes.
If this is the first time you're running your application on your Urbit ship, don't forget to `|start %pottery`.
### `npm run serve`
Builds the application and copies it into your Urbit ship's desk, watching for changes. In your Urbit `|commit %home` (or `%your-desk-name`) to synchronise your changes.