- uses: actions/setup-java@v1

with:

java-version: 1.8

- uses: DeLaGuardo/setup-clojure@3.2

with:

cli: 1.10.1.693

- uses: actions/setup-java@v1

with:

java-version: 1.8

- uses: DeLaGuardo/setup-clojure@3.2

with:

cli: 1.10.1.693

on: push

- uses: actions/setup-java@v1

with:

java-version: 1.8

- uses: DeLaGuardo/setup-clojure@3.2

with:

cli: 1.10.1.693

- name: Extract branch name

shell: bash

run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"

id: extract_branch

uses: JamesIves/github-pages-deploy-action@4.1.0

branch: gh-pages

folder: public

target-folder: branches/${{ steps.extract_branch.outputs.branch }}

- name: Slack Notification

uses: rtCamp/action-slack-notify@v2

env:

SLACK_CHANNEL: proj-dev-homebase-react

SLACK_COLOR: ${{ job.status }} # or a specific color like 'green' or '#ff00ff'

SLACK_ICON: https://github.com/homebaseio.png?size=200

SLACK_MESSAGE: "- :github: Branch: <https://github.com/homebaseio/homebase-react/tree/${{ steps.extract_branch.outputs.branch }}|${{ steps.extract_branch.outputs.branch }}>\n- :card_file_box: devcards: https://homebaseio.github.io/homebase-react/branches/${{ steps.extract_branch.outputs.branch }}/index.html"

SLACK_TITLE: "Published ${{ steps.extract_branch.outputs.branch }} to GitHub Pages :rocket:"

SLACK_USERNAME: Homebase

SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

Homebase React uses ClojureScript and its corresponding data format EDN internally. We then compile all of that to Javascript using the Google Closure Compiler (closure not clojure, I know right) to get as small a bundle as possible. Then we provide APIs (react hooks) that accept JSON and do all the conversion to EDN and back again behind the scenes.

EDN and Clojure provide far more safety and extensibility than JSON and Javascript. Clojure being immutable by default and EDN being extensible. This lets us build and support features that would be unwieldy in JSON and JS.

However, the tradeoffs are:

1. A larger bundle size. Some of the Clojure runtime cannot be compiled away even though the closure compiler is really aggressive.

2. Clojure error messages sometimes leak into JS land. We try to annotate the ones we know about so they make sense to JS devs, but it's far from perfect and if you see something weird please create an issue.

3. Our code is released already minified. We do this because most people do not develop with the google closure compiler and other build tools are not nearly as effective at optimizing this code. This makes debugging homebase-react while developing a bit harder since the code is not very readable, but we think the tradeoff is worth it to provide a smaller bundle size. And to compensate we try to build enough supporting dev tooling so you never need to read the compiled source.

4. Confusing console logs. EDN data looks different from JSON and to add to that, homebase-react mostly outputs entities, which are lazy data types and not very helpful when logged out with the default console formatting. See custom chrome formatters below for a vastly improved logging experience.

If you develop with [Chrome](https://www.google.com/chrome/) or a Chromium browser like Brave or Edge you'll get significantly more meaningful logs for entities `console.log(anEntity)` due to our use of custom chrome :formatters. These custom formatters allow us to perform lazy database queries to fetch all of an entity's attributes, including references to other entities and all reverse references to the current entity. They let you access your entire data graph from the console, with any logged out entity as an entry point.

**To enable custom chrome formatters**

**1.** Open the preferences panel in chrome devtools by clicking the cog.

<img alt="image of chrome devtools preferences button" src="public/images/enable_chrome_formatters_1.png" width="400">

**2.** Toggle `Enabled custom formatters` on.

<img alt="image of chrome devtools custom formatters toggle" src="public/images/enable_chrome_formatters_2.png" width="400">

**3.** Keep the chrome console open and refresh the page. Any logged out entities should now have the custom formatting.

<img alt="image of custom entity chrome console logs" src="public/images/enable_chrome_formatters_3.png" width="400">

**Live demo:** open the console while on the [todo example](https://homebaseio.github.io/homebase-react/#!/dev.example.todo) page.

**Remember**: for custom formatters to work `console.log(anEntity)` must be called *after* you open the chrome console. Anything logged out before you open the console will not have custom formatting applied because chrome processes those logs in the background.

*Use [custom chrome formatters](#custom-chrome-formatters) instead.*

1. Improve developer tools: custom chrome formatters, DB admin console extension

2. Rewrite React ↔ Homebase cache

1. Support async DB access (for Datahike)

2. Reactive query planning (better perf on pages with lots of live reads)

3. Swap [Datascript](https://github.com/tonsky/datascript) out for [Datahike](https://github.com/replikativ/datahike)

4. Persist to IndexedDB

5. [Local-first](https://www.inkandswitch.com/local-first.html) conflict resolution for offline caching and sync between multiple devices

{:paths ["src"]

:deps {thheller/shadow-cljs {:mvn/version "2.11.25"}

devcards/devcards {:mvn/version "0.2.7"}

datascript/datascript {:mvn/version "1.0.7"}

reagent/reagent {:mvn/version "1.0.0-alpha2"}

inflections/inflections {:mvn/version "0.13.2"}

binaryage/devtools {:mvn/version "1.0.2"}

homebaseio/datalog-console {:git/url "https://github.com/homebaseio/datalog-console" :sha "91d5b6009d66807ceec9807a1f8ed099a0a6f219"}

;; homebaseio/datalog-console {:local/root "../datalog-console"}

camel-snake-kebab/camel-snake-kebab {:mvn/version "0.4.2"}}}

Homebase React enables developers to access the same embedded datalog database as Roam Research through React hooks. You no longer have to build out a team or learn specialized tools like Clojure in order to build a delightful write-heavy application.


Ok. Let's get going.

Adding `HomebaseProvider` automatically creates the database.

For a step by step guide take a look at the [tutorial](/docs/homebase-react/main/tutorial).

Check out the [API docs](/docs/homebase-react/main/api) to learn about our other hooks like [`useQuery`](/docs/homebase-react/main/api#usequery) and [`useClient`](/docs/homebase-react/main/api#useclient).


Welcome back. Let's get started for real.