-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ink!athon references & subpage (#278)
* fix: Improve `dApp` casing consistency * feat: Improve `JSPackageHero` * feat: Improve frontend overview & Add ink!athon reference * feat: Add ink!athon subpage under third-party tools * feat: Update & fix links
- Loading branch information
Showing
13 changed files
with
200 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: ink!athon DApp Boilerplate | ||
slug: /getting-started/inkathon | ||
--- | ||
|
||
# ink!athon DApp Boilerplate | ||
|
||
ink!athon is a starter kit 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. It's developed by the same team that is behind [AZERO.ID](https://azero.id), where this boilerplate is used in production. | ||
|
||
## Getting started | ||
|
||
* Try out an interactive example deployment under [inkathon.xyz](https://inkathon.xyz). | ||
* To get started with development, head over to the [ink!athon repository](https://github.com/scio-labs/inkathon) and check its README. | ||
|
||
## Workshop Video | ||
|
||
Get a quickstart into the boilerplate with this talk recording by [Dennis Zoma](https://twitter.com/dennis_zoma) at the sub0 Developer Conference in Lisbon 2023: **[Start Building dApps on ink!](https://www.youtube.com/watch?v=SoNLZfsd0mQ)** (46 min). | ||
|
||
[![inkathon Workshop Video Preview Image](/img/inkathon-workshop-video-preview.jpg)](https://www.youtube.com/watch?v=SoNLZfsd0mQ) | ||
|
||
## Architecture | ||
|
||
The starter kit is set up as a monorepo with two packages. | ||
|
||
* `packages/contracts`: ink! smart contracts with: | ||
* `Greeter` example contract | ||
* shorthand build & deploy scripts that export metadata and contract addresses | ||
* pre-configured `substrate-contracts-node` | ||
* extensible JS/TS `scripts/` setup | ||
* `packages/frontend`: Next.js frontend with: | ||
* `polkadot-js/api` & `scio-labs/use-inkathon` dependencies | ||
* pre-configured to import deployments & addresses from above | ||
* styling with tailwindcss and/or chakra-ui | ||
* components for balance checking, wallet connection, network information, and sample contract interaction | ||
|
||
![inkathon Architecture Diagram](/img/inkathon-architecture.jpg) | ||
|
||
|
||
## Community & Support | ||
|
||
import { BigCTA } from '../../src/components/BigCTA' | ||
|
||
<BigCTA | ||
title="Telegram Group" | ||
emphasized="Join" | ||
cta="the conversation" | ||
url="https://t.me/inkathon" | ||
/> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.