Skip to content

Commit

Permalink
chore: Update readme, description, and license
Browse files Browse the repository at this point in the history
  • Loading branch information
wottpal committed Jan 11, 2023
1 parent 6132be3 commit 8e612c1
Show file tree
Hide file tree
Showing 6 changed files with 694 additions and 30 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
LICENSE
695 changes: 674 additions & 21 deletions LICENSE

Large diffs are not rendered by default.

11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# INK!athon – Substrate-based Smart Contract & DApp Boilerplate
# INK!athon – DApp Boilerplate for Substrate & ink!

![Typescript](https://img.shields.io/badge/Typescript-blue)
![ink!](https://img.shields.io/badge/ink!-purple)
![Next.js](https://img.shields.io/badge/Next.js-gray)
![Tailwind](https://img.shields.io/badge/Tailwind-pink)
![ink!](https://img.shields.io/badge/ink!-purple)
[![Scio Labs](https://img.shields.io/badge/Scio%20Labs-We%20are%20hiring-black)](https://scio.xyz)

<img src="packages/frontend/public/images/mix-cover.jpg" width="800" height="auto" alt="Cover Image" />

---

This is an opinionated boilerplate/starterkit/scaffold to get up and running with smart contract & dApp development in the Substrate ecosystem.

It also comes in handy for hackathons. 👀
This is an opinionated boilerplate to get up and running with dApp development in the Substrate ecosystem, especially with ink! smart contracts. It uses custom-built [`useInkathon` React Hooks](https://github.com/scio-labs/use-inkathon) that abstract & improve the polkadot.js experience.

By [Dennis Zoma](https://twitter.com/dennis_zoma) 🧙‍♂️ & [Scio Labs](https://scio.xyz) 💫.
By [Dennis Zoma](https://zoma.dev) 💫 & [Scio Labs](https://scio.xyz) 🪐

---

Expand Down
11 changes: 10 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
{
"name": "@inkathon/monorepo",
"description": "Full-stack dApp boilerplate for Substrate-based networks and ink! Smart Contracts",
"version": "0.0.1",
"license": "MIT",
"license": "GPL-3.0",
"homepage": "https://inkathon.xyz",
"repository": {
"type": "git",
"url": "git+https://github.com/scio-labs/inkathon"
},
"bugs": {
"url": "https://github.com/scio-labs/inkathon/issues"
},
"private": true,
"workspaces": [
"packages/*"
Expand Down
3 changes: 2 additions & 1 deletion packages/contracts/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "@inkathon/contracts",
"license": "MIT",
"version": "0.0.1",
"license": "GPL-3.0",
"homepage": "https://inkathon.xyz",
"scripts": {
"build": "cargo +nightly contract build --optimization-passes=0 --release --manifest-path ${CONTRACT:-greeter}/Cargo.toml && pnpm copy-build",
"copy-build": "mkdir -p ${CONTRACT:-greeter}/deployments/ && cp ${CONTRACT:-greeter}/target/ink/metadata.json ${CONTRACT:-greeter}/deployments/ && cp ${CONTRACT:-greeter}/target/ink/${CONTRACT:-greeter}.contract ${CONTRACT:-greeter}/deployments/",
Expand Down
3 changes: 2 additions & 1 deletion packages/frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "@inkathon/frontend",
"license": "MIT",
"version": "0.0.1",
"license": "GPL-3.0",
"homepage": "https://inkathon.xyz",
"babelMacros": {
"twin": {
"preset": "emotion"
Expand Down

0 comments on commit 8e612c1

Please sign in to comment.