@holochain-syn/core

Core package to easily build syn Holochain applications.

Installing

Install the necessary dependencies:

npm install @holochain-open-dev/profiles @holochain-syn/core

Note: Syn uses Automerge, which depends on WebAssembly (WASM). Some build tools and bundlers require additional configuration to properly handle WASM modules.

For Vite users: Add the WASM plugin to your development dependencies in package.json:

{
  "devDependencies": {
    "vite-plugin-wasm": "^3.5.0"
  }
}

Configure the plugin in your vite.config.ts:

import { defineConfig } from 'vite';
import wasm from 'vite-plugin-wasm';

export default defineConfig({
  plugins: [wasm()],
});

Usage

First, you need to have instantiated a SynStore from @holochain-syn/store and a ProfilesStore from @holochain-open-dev/profiles.

Defining the Context Providers

// Define the <profiles-context> element
import '@holochain-open-dev/profiles/dist/elements/profiles-context.js';

// Define the <syn-context> element
import '@holochain-syn/core/dist/elements/syn-context.js';

Now define the and the element and add it to your html wrapping the whole section of your page in which you are going to be placing the elements from @holochain-syn/elements:

<profiles-context id="profiles-context"> 
  <syn-context>
    <!-- The rest of your application goes here -->
  </syn-context>
</profiles-context>

Connect the Store to the Context Providers

Go to this page, select the framework you are using, and follow its example in order to:

• Connect the ProfilesStore to the with id="profiles-context".
• Connect the SynStore to the .