diff --git a/packages/docs/docs/tutorial/Deployment.md b/packages/docs/docs/tutorial/Deployment.md new file mode 100644 index 00000000..7ba00d27 --- /dev/null +++ b/packages/docs/docs/tutorial/Deployment.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 2 +--- +## How to deploy a memecoin using unruggable? + +### connect your wallet +first thing first, you need to head to unruggable portal and connect your starknet wallet. this is the most technical step:) + +![connect starknet wallet](./img/connect_wallet.png) + +

+ +### deploy your memecoin +It's time to navigate to the deploy page. to do that, Simply click on the "Deploy" button: + + +![deploy button](./img/deploy%20button.png) + +

+ +then there is a form that should filled with proper values: + +![deploy form](./img/deploy_page.png) + +here is what you need to know about this form: +- `Name`: the name of your memecoin like `Cool Meme Token` +- `Symbol`: the symbol of your memecoin like `CMT` +- `Owner Address`: probably it's best to put `your starknet wallet address` there. (by clicking the wallet logo, it will fill with your connected wallet address.) +- `Initial Supply`: the supply of your memecoin like `21,000,000` + + +click on the deploy button and it will pop up a contract call from your wallet to create the specific memecoin: + +![memecoin transaction](./img/memecoin_transaction.png) + diff --git a/packages/docs/docs/tutorial/Launch/AMM.md b/packages/docs/docs/tutorial/Launch/AMM.md new file mode 100644 index 00000000..73e89db7 --- /dev/null +++ b/packages/docs/docs/tutorial/Launch/AMM.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 1 +--- +### list on AMMs +Congratulations! You have successfully created your memecoin on starknet. Now it's up to you to decide which liquidity provider on starknet to use for your token. + +![choose AMM](./../img/amm.png) + +currently, options are among: +- **Ekubo**: Most efficient AMM ever, you can launch your token without having to provide liquidity and can collect fees. +- **Jediswap**: Widely supported AMM, team allocation will be free but you have to provide liquidity and can't collect fees. +- **StarkDeFi**: Team allocation will be free but you have to provide liquidity and can't collect fees. + diff --git a/packages/docs/docs/tutorial/Launch/Anti bot.md b/packages/docs/docs/tutorial/Launch/Anti bot.md new file mode 100644 index 00000000..4c67429f --- /dev/null +++ b/packages/docs/docs/tutorial/Launch/Anti bot.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 3 +--- +### Anti bot +next step is to set anti bot (hold limit). you know that bots are everywhere and if they spot a new pool in one of the AMMs, they probably buy a big portion of that token before users notice that. so it's totally up to you to use this feature. + +![choose AMM](./../img/antibot.png) + +> e.g. %1 for 24:00 means no single wallet can buy more than 1% of the token for 24 hours after launch from the AMM. After that time, this limit vanishes. diff --git a/packages/docs/docs/tutorial/Launch/Launch.md b/packages/docs/docs/tutorial/Launch/Launch.md new file mode 100644 index 00000000..b84ebad9 --- /dev/null +++ b/packages/docs/docs/tutorial/Launch/Launch.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 5 +--- +### launch time +finally, it's launch time! + +![market cap and pair](./../img/launch.png) + +review the details and Hit the launch button to launch your memecoin on AMM. (this will required a transaction from your wallet.) + +![market cap and pair](./../img/launch_transaction.png) + +that's it. + + +

+ +**Question** + +I created a memecoin using a tutorial. How can I find my memecoin contract address? + +> You can find your meme token info in the "My Tokens" section. More details are available on this page. + diff --git a/packages/docs/docs/tutorial/Launch/Pool attributes.md b/packages/docs/docs/tutorial/Launch/Pool attributes.md new file mode 100644 index 00000000..caf83623 --- /dev/null +++ b/packages/docs/docs/tutorial/Launch/Pool attributes.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 4 +--- +### Market cap, token pair and fee +The next step involves setting the token pair and market cap, as well as determining the fee. + +![market cap and pair](./../img/init.png) + +you have to set + +- `Starting market cap` which is at your disposal +
and
+- `qoute token` which is the pair against your memecoin token. you can choose a stable one like: USDC or starknet native token STRK or the popular ETH. +- `fee` which is again totally up to you. + diff --git a/packages/docs/docs/tutorial/Launch/Team allocation.md b/packages/docs/docs/tutorial/Launch/Team allocation.md new file mode 100644 index 00000000..c7737f06 --- /dev/null +++ b/packages/docs/docs/tutorial/Launch/Team allocation.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 2 +--- +### team allocation +After selecting the liquidity pool, you will be directed to the team allocation page.(For this documentation, we will use **Ekubo**.) + +![choose AMM](./../img/team.png) +
+On this page, you can allocate some of your tokens to your team, friends, and Vitalik! diff --git a/packages/docs/docs/tutorial/Launch/_category_.json b/packages/docs/docs/tutorial/Launch/_category_.json new file mode 100644 index 00000000..4ed9e596 --- /dev/null +++ b/packages/docs/docs/tutorial/Launch/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Launch", + "position": 3, + "link": { + "type": "generated-index", + "description": "a few minutes to learn how to launch memecoin on the starknet AMMs." + } +} diff --git a/packages/docs/docs/tutorial/img/amm.png b/packages/docs/docs/tutorial/img/amm.png new file mode 100644 index 00000000..1c82bbdd Binary files /dev/null and b/packages/docs/docs/tutorial/img/amm.png differ diff --git a/packages/docs/docs/tutorial/img/antibot.png b/packages/docs/docs/tutorial/img/antibot.png new file mode 100644 index 00000000..c7d1dcfc Binary files /dev/null and b/packages/docs/docs/tutorial/img/antibot.png differ diff --git a/packages/docs/docs/tutorial/img/connect_wallet.png b/packages/docs/docs/tutorial/img/connect_wallet.png new file mode 100644 index 00000000..0094ff20 Binary files /dev/null and b/packages/docs/docs/tutorial/img/connect_wallet.png differ diff --git a/packages/docs/docs/tutorial/img/deploy button.png b/packages/docs/docs/tutorial/img/deploy button.png new file mode 100644 index 00000000..4fa28545 Binary files /dev/null and b/packages/docs/docs/tutorial/img/deploy button.png differ diff --git a/packages/docs/docs/tutorial/img/deploy_page.png b/packages/docs/docs/tutorial/img/deploy_page.png new file mode 100644 index 00000000..ad767098 Binary files /dev/null and b/packages/docs/docs/tutorial/img/deploy_page.png differ diff --git a/packages/docs/docs/tutorial/img/init.png b/packages/docs/docs/tutorial/img/init.png new file mode 100644 index 00000000..5b602f75 Binary files /dev/null and b/packages/docs/docs/tutorial/img/init.png differ diff --git a/packages/docs/docs/tutorial/img/launch.png b/packages/docs/docs/tutorial/img/launch.png new file mode 100644 index 00000000..e0d3120a Binary files /dev/null and b/packages/docs/docs/tutorial/img/launch.png differ diff --git a/packages/docs/docs/tutorial/img/launch_transaction.png b/packages/docs/docs/tutorial/img/launch_transaction.png new file mode 100644 index 00000000..056e5543 Binary files /dev/null and b/packages/docs/docs/tutorial/img/launch_transaction.png differ diff --git a/packages/docs/docs/tutorial/img/memecoin_transaction.png b/packages/docs/docs/tutorial/img/memecoin_transaction.png new file mode 100644 index 00000000..613ddf8a Binary files /dev/null and b/packages/docs/docs/tutorial/img/memecoin_transaction.png differ diff --git a/packages/docs/docs/tutorial/img/team.png b/packages/docs/docs/tutorial/img/team.png new file mode 100644 index 00000000..cc0b6326 Binary files /dev/null and b/packages/docs/docs/tutorial/img/team.png differ diff --git a/packages/docs/docs/tutorial/overview.md b/packages/docs/docs/tutorial/overview.md deleted file mode 100644 index e3c5e1ab..00000000 --- a/packages/docs/docs/tutorial/overview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: overview -sidebar_position: 1 -title: Overview ---- - -# How to use Unruggable App - -Lorem ipsum dolor sit amet... diff --git a/packages/docs/docs/tutorial/overview.mdx b/packages/docs/docs/tutorial/overview.mdx new file mode 100644 index 00000000..58c3492e --- /dev/null +++ b/packages/docs/docs/tutorial/overview.mdx @@ -0,0 +1,11 @@ +--- +id: overview +sidebar_position: 1 +title: Overview +--- + +# How to use Unruggable App + +Using unruggable is quite easy. you can either: +- `deploy` your favorite meme coin from its launch pad +- `check` if a token is unraggable or not. diff --git a/packages/docs/package.json b/packages/docs/package.json index d6130baa..e318d86e 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -47,7 +47,7 @@ ] }, "engines": { - "node": "16", + "node": ">=18", "yarn": ">=1.22" } }