https://github.com/chenyan2002/ic-elm

https://github.com/chenyan2002/ic-elm

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/chenyan2002/ic-elm
• Owner: chenyan2002
• Created: 2020-07-21T17:03:59.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T20:20:02.000Z (almost 2 years ago)
• Last Synced: 2024-05-21T12:54:16.588Z (6 months ago)
• Language: JavaScript
• Size: 773 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-internet-computer - ic-elm - A template for using Elm to develop frontend user interface for the Internet Computer. (Candid / Candid implementations)

README

        
# ic-elm

A template for using Elm to develop frontend user interface for the Internet Computer.

# Overview

Elm --> JSON --> JS Candid Encoder --> IC canister --> JS Candid Decoder --> JSON --> Elm

Currently Candid methods is untyped to Elm. The error only happens on the JS side in the runtime.

Eventually, we want to generate method bindings in Elm via the Candid compiler.

# Design choices

There are several options for the `port` function type in Elm:

* JSON value: It's the recommended way for Elm-JS interop. To transfer JS objects, mainly BigNumber and CanisterId, we need to convert objects/classes into a JSON representation, which can be done via the visitor pattern. The downside is that Elm needs to understand the JS specific representation of the Candid values. We can provide a codegen from candid file to hide the representation detail from the user.

* Variant type: JS doesn't have variant types, and Elm cannot transfer native variant types directly. So we need to design a JSON encoding for variant types, which requires work in both JS and Elm.

* String (Candid text format): This is language agnostic, and we can build a library for parsing and stringify the Candid values completely in Elm. On the JS side, there is little work required. Conceptually, this is better than JSON, as the format is in the spec and language agnostic, but it requires more work in Elm.

* Blob (Candid binary format): Also language agnostic, but a bit heavy weight (building type tables, skipping unused fields, etc), and we don't get any code reuse from the JS library.

Overall, it seems the easiest approach is to use JSON for Elm-JS interop.

# Usage 

```bash

cd ic-elm

npm install

dfx canister create --all

dfx build

dfx canister install --all

```

To learn more before you start working with elm, see the following documentation available online:

- [Quick Start](https://sdk.dfinity.org/docs/quickstart/quickstart.html)

- [SDK Developer Tools](https://sdk.dfinity.org/docs/developers-guide/sdk-guide.html)

- [Motoko Programming Language Guide](https://sdk.dfinity.org/docs/language-guide/motoko.html)

- [Motoko Language Quick Reference](https://sdk.dfinity.org/docs/language-guide/language-manual.html)