Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add page "How to use Unruggable App" for dedicated docs #238

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
35 changes: 35 additions & 0 deletions packages/docs/docs/tutorial/Deployment.md
Original file line number Diff line number Diff line change
@@ -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)

<br /><br />

### 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)

<br /><br />

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)

13 changes: 13 additions & 0 deletions packages/docs/docs/tutorial/Launch/AMM.md
Original file line number Diff line number Diff line change
@@ -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.

9 changes: 9 additions & 0 deletions packages/docs/docs/tutorial/Launch/Anti bot.md
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 23 additions & 0 deletions packages/docs/docs/tutorial/Launch/Launch.md
Original file line number Diff line number Diff line change
@@ -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.


<br /><br />

**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.

15 changes: 15 additions & 0 deletions packages/docs/docs/tutorial/Launch/Pool attributes.md
Original file line number Diff line number Diff line change
@@ -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
<br />and<br />
- `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.

9 changes: 9 additions & 0 deletions packages/docs/docs/tutorial/Launch/Team allocation.md
Original file line number Diff line number Diff line change
@@ -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)
<br />
On this page, you can allocate some of your tokens to your team, friends, and Vitalik!
8 changes: 8 additions & 0 deletions packages/docs/docs/tutorial/Launch/_category_.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
Binary file added packages/docs/docs/tutorial/img/amm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/docs/tutorial/img/antibot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/docs/tutorial/img/deploy_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/docs/tutorial/img/init.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/docs/tutorial/img/launch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/docs/docs/tutorial/img/team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 0 additions & 9 deletions packages/docs/docs/tutorial/overview.md

This file was deleted.

11 changes: 11 additions & 0 deletions packages/docs/docs/tutorial/overview.mdx
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion packages/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
]
},
"engines": {
"node": "16",
"node": ">=18",
"yarn": ">=1.22"
}
}