Emerald City Proposal

[jacob-tucker]

Hellooo! This is Jacob Tucker, filling out an issue to initiate this bounty on behalf of Emerald City.

Team Members:
The Building Guild of Emerald City. We have ~40 community members interested in building this out as a community and applying their talents to specific areas of the project.

Contact Info:
You can reach out to me at jacobtucker818@gmail.com or ping me in Discord (tsnakejake#8364). Additionally, you will be able to see the progress of the development of this platform in an open-source format in our Discord: discord.gg/emeraldcity

Why should we take on this bounty?
Emerald City has around 40 community members who are interested to take on this task. Because we have built projects/tools in an open-source format already (including the FLOAT platform and Emerald bot), we already know and identify the specific talents of our community members and can leverage that to build this platform quickly.

In addition, Emerald City treats the projects we build as a learning experience for Flow developers. We have a ton of members who recently graduated from our Academy who want to get their hands dirty with a full-scale DApp on Flow. In addition, some have not been a part of building full-scale projects in the past, and would like to use this as an opportunity to learn so they can create their own projects on Flow. They would not only learn how to tackle a "serious" application, but also learn how to make real MainNet projects on Flow.

Lastly, of course, we would use this as an opportunity to reward our experienced developers looking for work with this bounty and give them a place to contribute during the duration of the bounty.

Product Requirements Documentation and Tech Spec:

• The entire project will be open-source and will be built in the public eye (within Emerald City, which is itself public)
• For the NFT part...

The NonFungibleToken standard as it currently stands requires that you have 1 type of NFT per contract. Platforms like Rarible, though, use 1 Contract for all of their NFTs, and differentiate them by the metadata within the NFT itself. We will take a different approach, which I believe is more aligned with the requirements of this bounty, to deploy a different NFT contract for each creator (which I also think is what the example platforms provided were doing).

In order for this to take place, it will be required to have access to MainNet deployment at some point, but that is something to worry about at the end. For the duration of the bounty, we will test this deployment of contracts to the user's account on Emulator + Testnet.

One interesting side effect of this platform is that it requires us to think more deeply about NFT Metadata. As we know, the NFT Metadata standard was released not too long ago on MainNet, and has sought to become adopted by projects across the ecosystem. This is a perfect opportunity to integrate the standard without having to go through the pain of encouraging developers to implement it. If we automate it directly in the code, every NFT Collection created will automatically implement the standard, allowing for greater NFT discoverability across the ecosystem.

The platform itself will be straightforward - it will allow a user to log in through Blocto, walk through a step-by-step process to fiddle with NFT Metadata (which will have IPFS integration for images/videos/etc), and then display a resulting modal with the configured contract. I also really liked that https://www.721.so/ displayed the contract on the side bar while you were configuring the contract because it allows for the creator to learn something about smart contracts in the process. So we will have that too.

At that point, it's just a matter of making things look pretty.

[deayora]

TYSM @jacob-tucker and Emerald City! We will be reviewing this proposal and will get back to you in the next 1-2 weeks. We appreciate all your work and are looking forward to diving in.

[deayora]

Hi @jacob-tucker! Thank you for your teams interest in this bounty. We are eager for you all to get started on it. Per the bounty requirements, can your team please:

• Add a maintenance plan for the code once deployed to the above PRD
• Confirm your team will build/create the following as well:
  • User-friendly and intuitive GUI that guides users through the deployment process
    • It's important to us that creators (non developers) can use the tool easily.
  • Tablet- and mobile-friendly user interface
  • Include thorough documentation and walkthroughs for using the dapp

Re: MainNet Deployment - Per the last step of Milestone 4 (Production-Grade Build Complete)

• Upon reaching Milestone 4, the codebase for the Token Minter must be turned over to Dapper Collectives for deployment to Flow mainnet

Definitely let us know if you have any questions on this feedback. Once those are updated in a revised PRD commented below, we'll review, wrap up any further questions or approve and count this bounty awarded🙏

[jacob-tucker]

Thank you for response. We're super hyped to get started on this too.

Maintenance Plan
It is important to me and the Emerald City community that this tool be maintained and branded by Emerald City since our success relies on people knowing and recognizing our free tooling. Thus, we will take the responsibility of hosting the website and making sure things are smooth sailing once launched. In addition, we will constantly update the site with new features to the NFT Metadata Standard.

I can confirm that we will build out all of the features listed:

• User-friendly and intuitive GUI that guides users through the deployment process
  Absolutely. We will not require any coding knowledge.
• Tablet- and mobile-friendly user interface
  Yes, this will work on all devices
• Include thorough documentation and walkthroughs for using the dapp
  This will also be done. We will include docs on the site itself as well as walkthroughs to be uploaded on my YouTube channel and branded as Emerald City.

In regards to MainNet deployment, I want to confirm the process for what the deployment will look like. Each user who uses this platform will be creating their own NFT, and thus their own contract. So when this bounty is completed and sent in, there will be no contracts to deploy. Rather, they will need to be deployed on the fly when a user creates their own NFT. This is not supported on Flow at the moment, as MainNet deployment is closed. As per my understanding, it will be possible in the upcomings months though. Does this seem like what you were thinking as well?

Thanks deayora!

[deayora]

@jacob-tucker we would like to build this in a way - and get it audited and signed-off on internally - so that users can deploy their contracts on the fly. We feel that if the template is tight enough and through the GUI users are only updates metadata/images, this should be possible and a great first step for people deploying at will on Flow.

We will need to get double confirmation on this plan internally -- but in the meantime, I think if we build with the plan for deployment to be owned by users and remain aware of any design needs/steps that would need to be baked in if in interim we manage for manual deployment if we are unable to give users this ability.

If you feel you can approach this with the two potential paths in mind - we can consider this bounty awarded and get to building :)

[jacob-tucker]

Sounds great. I will get our community moving on this right away.

We will prioritize users owning deployment, but keep the other option in the back of our minds as well. At the very least, deployment should be open for all in a few months time, so worst case we have that path developed out for when that time arrives

[deayora]

Best news!! Milestone #1 complete :) I will alert my team and they'll kick-off reaching out and getting payment in progress. CONGRATULATIONS, EMERALD CITY!

[jacob-tucker]

If it's okay, I have a clarifying question @deayora to make sure we deliver as expected.

The proposal mentions that users should be able to learn how to upload their metadata to IPFS, and then use that metadata for their NFT collection, as mentioned here:
a.) Learn how to upload their assets and metadata to a service like IPFS; and
b.) Upload the metadata for their NFT collection.

There are many ways to create an NFT Collection, but most popularly is "generative art" where a user uploads like 500 images, names, and descriptions for their NFTs, and each one of those bundles is tied to a certain NFT ID. For example, NFT with ID #0 is mapped to the first image with name X and description Y, and ID #1 is mapped to the second image with name N and description M, etc.

Thus, our imagined end-user workflow is this:

1. User has a bunch of images, names, descriptions, etc for their NFTs in a folder
2. Uploads all of those to IPFS through our webpage
3. Uses the produced IPFS link to be passed into the collection and used for the NFT metadata

Is this the sort of functionality you were picturing for this bounty? I believe this is how https://721.so does it.

Thank you!

[deayora]

@jacob-tucker This workflow is awesome and sounds great - some small notes/thoughts 🔥

• Uploading to IPFS via your site: We'll want to make sure to give them a preview of what the work will look like due to permanence post minting. Would be great to create some supporting language at this point to double check it all looks 👍
• The user will have to share their private IPFS keys to upload images through the website. Adding a field for the user to provide their own IPFS link if they're not comfortable uploading to directly to the site could be a great addition.

Let me know any further thoughts or questions 🤸

[Andreandi]

will this be project no.1 in the future

[jacob-tucker]

@deayora That sounds great, thank you <3

One more question I have for you: The bounty mentions creating the collections for the NFTs, which means our website will have to support people creating their own NFT collections. We are currently working on this right now. This means we don't have to include a page where users actually mint those NFTs from a collection, is this correct? The collection creator will handle this on their own.

Thanks again :)

[deayora]

@jacob-tucker missed this somehow! apologies :) sounds correct!

[jacob-tucker]

@deayora @zikewu I have some updaaaaates! :D :D

We are submitting just for Milestone #2 right now. We have the frontend clickable prototype: https://token-minter-kr7ibrjw1-emerald-dao.vercel.app/

It has both the guide and the collection generator. These are just prototypes and not finalized, but shows anticipated user workflow. Let us know what you think!

[zikewu]

@jacob-tucker WOAH the prototype looks Awesome!!! I sent the prototype to DC team for review. Will get back to you next week!

[deayora]

Good morning! Apologies for delay here @jacob-tucker and team :) This prototype is looking really awesome. We have some fine-tuning details that we believe will help from a usability and product standpoint.

• Shadowed headline-level text can be hard to read for folks with accessibility needs; please change to headline typeface without a shadow effect
• Change Emerald City to Emerald City Discord
• Change Guide to User Guide
• Increase amount of space between Collection Generator and User Guide and Emerald City Discord
• In the Collection Generator, change Description to something like Instructions
• At the Contract Information step, some tooltips or explanations of what each of the checkboxes accomplishes will be necessary
• Decrease spacing between steps so it's clearer that these are steps to a singular / not separate sections.
• Your numbered steps module used on the collection generator could be mirrored on "User Guide" section for continuity and ease of usability.

[deayora]

Really love the addition of Spanish to the user guide section. Are you planning to translate the collection generator section as well?

Same with the Discord Management Tool: We're eager to see the completed descriptions of the features on the main page in order to consider the front-end complete. In those descriptions, we especially want to make sure people understand what they're creating and how -- from landing page, to collection generator to user guide. Let us know if you have any questions there....

Thanks again - and as always - awesome work!