Skip to content

Commit

Permalink
[WIP] Add references to ink!athon Boilerplate & Restructure ink! cont…
Browse files Browse the repository at this point in the history
…ent (w3f#5241)

* fix: Make husky compatible with nvm

* feat: Add ink!athon boilerplate references

* feat: Minor status updates

* fix: Remove ink!athon double entry

* fix: Rename "ink" to "ink!" in subheading

* feat: Move all ink!-related content into ink! section

* feat: Add ink!athon to builders starter guide
  • Loading branch information
wottpal authored Oct 3, 2023
1 parent e24cc0c commit beea98e
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 20 deletions.
5 changes: 5 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

# Compatability with nvm
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

npx lint-staged
23 changes: 14 additions & 9 deletions docs/build/build-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,21 +326,26 @@ For front-end applications, several options exist for interfacing with Substrate
(parachains, relay chains, etc.) and smart contracts. These often will interact with the RPC of a
Substrate node:

<Tabs groupId="clients" values={[ {label: 'Polkadot.js', value: 'pjs'}, {label: 'Subxt', value:
'subxt'}, {label: 'CAPI', value: 'capi'}, {label: 'React Hooks for ink!', value: 'ink'} ]}>
<!-- prettier-ignore -->
<Tabs groupId="clients" values={[ {label: 'Polkadot.js', value: 'pjs'}, {label: 'Subxt', value: 'subxt'}, {label: 'React Hooks for ink!', value: 'useink'}, {label: 'ink!athon Boilerplate', value: 'inkathon'} ]}>

<TabItem value="pjs"> Promise and RxJS APIs around Polkadot and Substrate based chains via RPC
calls. It is dynamically generated based on what the Substrate runtime provides in terms of
metadata. Full documentation & examples available. </TabItem>
metadata. Full documentation & examples
available&nbsp;<a href="https://polkadot.js.org/docs" target="_blank">here</a>. </TabItem>

<TabItem value="capi"> Capi is a framework (based on Typescript) for crafting interactions with
Substrate chains. It consists of a development server and fluent API, which facilitates multichain
interactions without compromising either performance or ease of use. </TabItem>
<TabItem value="subxt"> Query and submit extrinsics (transactions) to a Substrate node via RPC using
Rust. Also referred to as Rust Parity. Full documentation & examples
available&nbsp;<a href="https://github.com/paritytech/subxt" target="_blank">here</a>. </TabItem>

<TabItem value="subxt"> Submit extrinsics (transactions) to a Substrate node via RPC using Rust.
Also referred to as Rust Parity. </TabItem>
<TabItem value="useink"> React hooks library for ink! smart contracts that abstract the
functionality of polkadot.js. Full documentation & examples
available&nbsp;<a href="https://use.ink" target="_blank">here</a>. </TabItem>

<TabItem value="ink"> React hooks for ink! smart contracts </TabItem>
<TabItem value="inkathon">ink!athon is a starterkit for full-stack dApp development with ink! smart
contracts and a React-based frontend in one place. With convenient helper scripts and a
pre-configured project setup, it lets you scaffold any dApp quickly. Live example & full
documentation available&nbsp;<a href="https://inkathon.xyz" target="_blank">here</a>. </TabItem>

</Tabs>

Expand Down
Loading

0 comments on commit beea98e

Please sign in to comment.