nftfair console

docs/nftfair/console/user-guide.md

@@ -0,0 +1,75 @@
+# NFTFair Console User Guide
+
+This instruction will show you how to create an activity on the NFTFair console.
+
+## Sign in
+
+First, you need to sign in to our console using your wallet. Click the connect button and sign the message to sign in.
+
+![image](../../assets/nftfair/a33633b7-1c3c-4f95-989f-2280d903630d.png)
+
+## Set up your profile
+
+Next, you need to set up your profile, click "My Profile" on the sidebar, fill in your information, and click the "Save" button.
+
+![image](../../assets/nftfair/120f9c89-39c8-492a-bf5d-03fa5c324bc7.png)
+
+## Create your collection
+
+Before you create your activity, you need to create an NFT collection. Click the "Create" button on the sidebar and select "Create a new NFT collection".
+
+![image](../../assets/nftfair/a65d891c-9f68-4cdd-b97e-54bc35912b43.png)
+
+Then select the collection cover, and input your collection title and description. Next, click the asset uploader to select your NFT images.
+
+![image](../../assets/nftfair/22eae42e-82af-42ad-bc59-d43ab83b8e36.png)
+
+Fill in your NFT title and description and click "Create NFT Collection".
+
+![image](../../assets/nftfair/cb2c0d6c-0047-43dd-9065-e967a93142d6.png)
+
+You can visit the collection detail page and click actions on the top right of the page to add or update your NFT collection.
+
+![image](../../assets/nftfair/fefa2c78-6170-45af-8882-c8ced8831c1f.png)
+
+## Deploy your collection
+
+Once you finish editing the NFT collection, you can deploy it to the network. Select the network you want to deploy your NFT contract and select the NFT contract type, then click "Deploy NFT contract".
+
+Note: Once you deploy an NFT contract, you will no longer be able to add or update your NFT.
+
+![image](../../assets/nftfair/e9808cdc-1cf1-4fa6-98b3-545fbc02c028.png)
+
+## Create a new activity
+
+If your collection is successfully deployed, go back to the NFT collection details page and click the "Create Activity" button on the right top.
+
+![image](../../assets/nftfair/8b0fda82-bdc1-4f84-8607-433ce73c54e9.png)
+
+Next, input your activity name, activity time, and introduction. Choose your activity type. As the example shown below, we are going to create a mystery box activity,
+
+![image](../../assets/nftfair/14101464-07d2-46f2-8a3d-3712c02290f1.png)
+
+Then, we need to set up the mystery box content. Select the mystery box cover, and input the title, description, and purchase limit.
+
+In the mystery box content section, select those NFTs you want to put into this box.
+
+![image](../../assets/nftfair/14101464-07d2-46f2-8a3d-3712c02290f1-2.png)
+
+Finally, click the "Create" button to create the activity.
+
+## Configure activity themes
+
+Next, you can preview or configure your activity themes. Click on the configure themes button to set up your page themes.
+
+![image](../../assets/nftfair/da40a4f6-3f19-4557-9040-521ed1e6e06e.png)
+
+On the theme configuration page, you can update the activity banner, icon, title, description, etc... After you finish the configurations, click on the "Save Changes" button.
+
+![image](../../assets/nftfair/e13f1040-3453-4972-abbe-813b55411b8d.png)
+
+If your activity is ready, you can click the "Publish" button on the activity listing to set up your activity online.
+
+![image](../../assets/nftfair/094b291c-5624-44e4-b114-5fa9efe69be1.png)
+
+Finally, you can click the preview button on the activity list page, copy and post the activity link to your users.

docs/nftfair/introduction.md

@@ -2,26 +2,26 @@
 
 ![](../assets/nftfair-image.png){style="zoom:80%"}
 
-It comes as a surprise that NFT launches are hardly fair and hurt the very community built around it. Users have reasonable expectations of obtaining an item from an NFT collection, but instead find that pre-sniping and metadata exploits - where traits are revealed on-chain before the sale - are so common as to be expected. 
+It comes as a surprise that NFT launches are hardly fair and hurt the very community built around it. Users have reasonable expectations of obtaining an item from an NFT collection, but instead find that pre-sniping and metadata exploits - where traits are revealed on-chain before the sale - are so common as to be expected.
 
-It was in light of these current shortcomings that we sat down and deliberated on what a viable solution could be, and how it would look like. It was clear to us that fairness would be a crucial part of such a design. With the support of [Conveyor](https://conveyor.ata.network), [NFTFair](https://www.nftfair.app) was launched. 
+It was in light of these current shortcomings that we sat down and deliberated on what a viable solution could be, and how it would look like. It was clear to us that fairness would be a crucial part of such a design. With the support of [Conveyor](https://conveyor.ata.network), [NFTFair](https://www.nftfair.app) was launched.
 
 ## Features
 
 - Unexploitable fairness
-</br> Powered by Conveyor to ensure that metadata is not revealed before the NFT is bought and settled
+  </br> Powered by Conveyor to ensure that metadata is not revealed before the NFT is bought and settled
 - True randomness
-</br> Random numbers directly generated from Silicon, with the option of utilizing Verifiable Random Function 
+  </br> Random numbers directly generated from Silicon, with the option of utilizing Verifiable Random Function
 - Multi-chain support
-</br> EVM/WASM compatible, with support for major ecosystem blockchains such as Ethereum, BSC, and Polygon
+  </br> EVM/WASM compatible, with support for major ecosystem blockchains such as Ethereum, BSC, and Polygon
 - Gasless transactions
-</br> Intuitive experience to eliminate user friction and complexity 
+  </br> Intuitive experience to eliminate user friction and complexity
 
 ## (FIFO) Fairdrops
 
-Attackers with a technical edge can skip ahead of the queue and interact directly with the smart contract of a new collection. The rarest NFTs are snapped up before the average user has a chance to connect their wallet once the sale goes public. For an effective launch process, metadata cannot be revealed at any point of the NFT journey from bidding, selection to distribution. 
+Attackers with a technical edge can skip ahead of the queue and interact directly with the smart contract of a new collection. The rarest NFTs are snapped up before the average user has a chance to connect their wallet once the sale goes public. For an effective launch process, metadata cannot be revealed at any point of the NFT journey from bidding, selection to distribution.
 
-With NFTFair, first-in-first-out ordering enforced by Conveyor removes any room for exploitation. 
+With NFTFair, first-in-first-out ordering enforced by Conveyor removes any room for exploitation.
 
 ## Mystery Boxes
 
@@ -30,24 +30,26 @@ Users anticipate the excitement of not knowing the exact item and rarity of an i
 AT NFTFair, no one, including the hosting nodes, is able to glean the ordering before it has been decided. It is out of the question for anyone to favor bids based on undisclosed information, which ensures randomization.
 
 ## Templates
+
 NFTFair currently supports:
 
 - FIFO (First-In-First-Out) Fairdrops
-- Mystery Boxes Fairdrops 
+- Mystery Boxes Fairdrops
 
-More curated template versions coming soon. 
+More curated template versions coming soon.
 
 ## Network:
 
-NFTFair is compatible with most EVM networks, and is live on: 
+NFTFair is compatible with most EVM networks, and is live on:
 
 - BSC
-- Polygon 
+- Polygon
 
 We are also working hard to expand the list of supported networks. Share your project with us [here](https://docs.google.com/forms/d/e/1FAIpQLScU36yLYWuiL3gXVvy7NwvnY-t4JD0u6XUvhTeaogCzQDzQpw/viewform) or drop us a [message](mailto:nftfair@ata.network).
 
 ## Category
-A category is what defines a collection of NFTs. Properties that can be configured include: 
+
+A category is what defines a collection of NFTs. Properties that can be configured include:
 
 - NFT Contract
 - Range of Token IDs
@@ -57,36 +59,43 @@ A category is what defines a collection of NFTs. Properties that can be configur
 Projects must define at least one category before sending NFTs to Fairdrop vaults.
 
 ## Sales
-Prices can be set for NFTs in different categories (i.e. collections). Proceeds from the sale can be withdrawn from the platform once the launch has ended. 
 
-As each Fairdrop vault only accepts a single ERC20 payment token, it is not possible to price Category A at 100 USDC, and Category B at 100 BTC. Projects can choose to price different categories for varying amounts of the same token. For example, Category A at 100 UDSC and Category B at 1000 USDC. 
+Prices can be set for NFTs in different categories (i.e. collections). Proceeds from the sale can be withdrawn from the platform once the launch has ended.
+
+As each Fairdrop vault only accepts a single ERC20 payment token, it is not possible to price Category A at 100 USDC, and Category B at 100 BTC. Projects can choose to price different categories for varying amounts of the same token. For example, Category A at 100 UDSC and Category B at 1000 USDC.
 
 ## Costs
-NFT launches on the platform are performed with gasless transactions. For users to benefit from zero-cost transactions, projects may choose to opt for relayer-sponsored transactions. Projects bear the full gas cost and users do not have to pay for any transaction fees. 
 
-Please reach out to [us](mailto:nftfair@ata.network) for more cost details. 
+NFT launches on the platform are performed with gasless transactions. For users to benefit from zero-cost transactions, projects may choose to opt for relayer-sponsored transactions. Projects bear the full gas cost and users do not have to pay for any transaction fees.
+
+Please reach out to [us](mailto:nftfair@ata.network) for more cost details.
 
-## To get started 
-Make sure you have the below information ready: 
+## To get started
+
+Make sure you have the below information ready:
 
 - Activity name. Example: Automata NFT Egg Hunt
 
-- Page title. Example: Come and crack your own egg! 
+- Page title. Example: Come and crack your own egg!
 
 - Start and end time for the Fairdrop
 
-- Official website and social media links 
+- Official website and social media links
 
 - Short description to introduce your project. (Example: Automata NFT Egg Hunt is a mystery box competition launched and hosted on NFTFair to celebrate the spirit of Easter with the community.)
 
-- List of commmon FAQs 
+- A list of FAQs to let users know about the Fairdrop.
+
+- A horizontal brand logo, higher than 200px. [Example](https://ipfs.io/ipfs/bafybeihapvgs3ifvv5ts3soxpkez37yo6dln6smlza3smpjjj7dktk7fta/supercar-logo.png)
+
+- A square brand logo, bigger than 500px. [Example](https://ipfs.io/ipfs/bafybeie5adkgmljzx7qzeulnwnq3laqsne4w5myic6c75kk2sqviqdjtua/supercar-icon.png)
 
-- A horizontal brand logo, more than 200px. [Example](https://ipfs.io/ipfs/bafybeihapvgs3ifvv5ts3soxpkez37yo6dln6smlza3smpjjj7dktk7fta/supercar-logo.png)
+- A square cover for your activity, bigger than 500px. [Example](https://ipfs.io/ipfs/bafybeicbfrketst3vtf5yn2q6ty5ww5yt7lvxy64d3rhdnv6b4vz3etsqq/1%20peewee%20egg.png)
 
-- A square brand logo, more than 500px. [Example](https://ipfs.io/ipfs/bafybeie5adkgmljzx7qzeulnwnq3laqsne4w5myic6c75kk2sqviqdjtua/supercar-icon.png)
+- A banner related to the theme of the Fairdrop with size 2132x224px [Example](https://ipfs.io/ipfs/bafybeicywiylhs2w6jfofgzhaw3gfnl2pen2u4wgsrmxuu7crlx46uilbe/supercar-banner.jpeg)
 
-- A banner related to the theme of the Fairdrop, 2132 x 224px. [Example](https://ipfs.io/ipfs/bafybeicywiylhs2w6jfofgzhaw3gfnl2pen2u4wgsrmxuu7crlx46uilbe/supercar-banner.jpeg)
+- A small 32x32px square icon for the browser tab bar. [Example](https://static.wixstatic.com/media/0653dd_303a21ade8b64ed5bca9f2755b2cb4a5~mv2.png/v1/fill/w_32%2Ch_32%2Clg_1%2Cusm_0.66_1.00_0.01/0653dd_303a21ade8b64ed5bca9f2755b2cb4a5~mv2.png)
 
-- A favicon for the browser tab, 32 x 32px. [Example](https://static.wixstatic.com/media/0653dd_303a21ade8b64ed5bca9f2755b2cb4a5~mv2.png/v1/fill/w_32%2Ch_32%2Clg_1%2Cusm_0.66_1.00_0.01/0653dd_303a21ade8b64ed5bca9f2755b2cb4a5~mv2.png)
+- The meta data for your NFTs. Required: name, image [Example](https://ipfs.io/ipfs/bafybeih5qzros2ysahzo2x5bo3rjaqfhfcqt47ncxrbk6mi3y2flu3f4dq/5%20extra-large%20egg.png). Optional: description, tags, properties, etc...
 
-Once the setup is complete, projects can then transfer or mint the NFTs to the Fairdrop Vaults. If you wish to enable the wallet connect function with your infura id, please share the id with us. Read more about [Wallet Connect](https://walletconnect.com/) and [Infura ID](https://infura.io/).
+- The infomation for each of your mystery boxes: a cover (930x294px, [example](https://ipfs.io/ipfs/bafybeiehhoqx54wf6o6cgu7etjxxlhfxa2qstf6ay75lzi4o3thxf26e6i/box-banner.png)), title(Less than 70 characters) and short description(Less than 200 characters), the purchase limit and the price(paid activity required).

mkdocs.yml

@@ -25,6 +25,8 @@ nav:
       - User Info:
         - Overview: ./nftfair/users/activities.md
         - FAQs: ./nftfair/users/faq.md
+      - Console:
+        - User Guide: ./nftfair/console/user-guide.md
       - Contracts:
         - Summary: ./nftfair/contracts/summary.md
         - NFTFairFactory: ./nftfair/contracts/factory.md