https://github.com/arthyn/gin-tonic

ship sync and sail hot reloading for urbit development
https://github.com/arthyn/gin-tonic

Last synced: about 2 months ago
JSON representation

ship sync and sail hot reloading for urbit development

• Host: GitHub
• URL: https://github.com/arthyn/gin-tonic
• Owner: arthyn
• Created: 2022-10-12T05:31:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T19:09:55.000Z (3 months ago)
• Last Synced: 2024-07-05T14:47:52.023Z (3 months ago)
• Language: TypeScript
• Size: 59.6 KB
• Stars: 24
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-urbit - gin & tonic - sync and auto-refresh (Developer Tools / SAIL)

README

        
# gin and tonic

Two companions making [sail](https://developers.urbit.org/guides/additional/sail) 

development much nicer.

**gin**: a utility for syncing files from a repository to a clay desk and

committing on save.

**tonic**: a library which auto refreshes your sail page on commit

## getting started

1. First you should install `gin`:

   ```bash

   npm i -g gin-tonic

   ```

2. Next run `gin add` to add a workspace which will be used to sync your 

   files from your repository to the Urbit you're working on and commit.

3. Then run `gin pour` to add the tonic library to your Urbit.

4. Integrate tonic into your gall application by wrapping your gall agent:

   ```hoon

    /+  tonic

    ...

    %-  agent:tonic

    |_  =bowl:gall

    ...

   ```

5. Include tonic's script in each sail page:

  ```hoon

  /+  tonic

  ...

  ;head

    ...

    ;+  (inject:tonic q.byk.bowl)

  ==

  ```

6. Finally run `gin watch` and pick your workspace. Gin will run until

   cancelled syncing your changes.

7. Sip and enjoy!