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 quick-dapp plugin #4844

Merged
merged 22 commits into from
Aug 26, 2024
Merged

add quick-dapp plugin #4844

merged 22 commits into from
Aug 26, 2024

Conversation

drafish
Copy link
Contributor

@drafish drafish commented Jun 5, 2024

Try it here -- https://remix-quick-dapp.vercel.app/

Here is the explanation for the references in code.

https://remix-dapp.pages.dev is the domain of the dapp template.

https://remix-dapp.pages.dev/manifest.json is the json file contains all the static files paths of dapp-template. It's generated through the build process automatically.

Before the dapp deployment, quick-dapp plugin will get all the static files paths of dapp-template, and download them from the dapp-template domain.

https://vercel-proxy-bice-six.vercel.app is the proxy to resolve the cross-domain issue. Because the backend service of surge does not support cross-domain.

Here is the codebase of the dapp-template https://github.com/drafish/remix-dapp
Here is the codebase of the proxy https://github.com/drafish/vercel-proxy

They are not in the remix codebase.

@ryestew

Copy link

netlify bot commented Jun 5, 2024

👷 Deploy request for remixproject pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 76b630b

@drafish drafish force-pushed the quick-dapp branch 3 times, most recently from 97f36df to b77bdb9 Compare June 19, 2024 08:59
@yann300
Copy link
Contributor

yann300 commented Jul 1, 2024

@drafish how would you recommend to add e2e test for the plugin and the site template?

@yann300 yann300 added the code reviewed PR code has been reviewed label Jul 2, 2024
@drafish drafish requested a review from LianaHus July 3, 2024 08:43
@drafish
Copy link
Contributor Author

drafish commented Jul 4, 2024

@drafish how would you recommend to add e2e test for the plugin and the site template?

For the plugin

  1. Click the edit icon in the deployed contract, and see if the plugin is activated successfully.
  2. Then do the drag and drop thing, and delete some functions.
  3. Then input some titles and instructions, and test the natspec by the way.
  4. Select all the rest options, such as share to, verified by etherscan, no terminal, themes
  5. Input email, password, subdomain, and click deploy. May need retry here, because the deployment may fail sometimes.

For the deployed dapp

  1. open the dapp domain in a new browser tab, see if it's loaded successfully.
  2. check if the order of the functions is correct, and the deleted functions are not shown.
  3. check if the titles and instructions are correct
  4. check share to, verified by etherscan, no terminal, themes
  5. send some transactions. (I'm not sure it's testable. Is it possible to preset metamask in Selenium?)

By the end of the e2e test, we should delete the subdomain which has be deployed in the e2e test.

For the dapp template, same as the e2e test for the deployed dapp.

  1. open the dapp-template domain, see if it's loaded successfully.
  2. check if the order of the functions is correct, and the deleted functions are not shown.
  3. check if the titles and instructions are correct
  4. check share to, verified by etherscan, no terminal, themes
  5. send some transactions. (I'm not sure it's testable. Is it possible to preset metamask in Selenium?)

@yann300

@yann300 yann300 self-requested a review July 4, 2024 08:04
@yann300
Copy link
Contributor

yann300 commented Jul 8, 2024

@LianaHus could you review the UI once more?

@drafish
Copy link
Contributor Author

drafish commented Jul 18, 2024

I think there is a better way to do e2e test for the dapp-template.

For now, the dapp-template is in an individual repository. I have to do the e2e test in that repository.

But what if I put it into to remix codebase, just like any other iframe plugins under folder apps . So that quick-dapp plugin can load the dapp-template from the ide domain during the dapp deployment. Then I don't need to do e2e test specifically for the dapp-template, when I'v already do the e2e test for the deployed dapp on Surge.

And there is another advantage in this way. It will be easy to keep versions in sync between quick-dapp and dapp-template, because they are in the same repository.

The only question is, can I put dapp-template into remix codebase, even it's not a remix plugin? @yann300 @ryestew

@yann300
Copy link
Contributor

yann300 commented Jul 18, 2024

the only question is, can I put dapp-template into remix codebase, even it's not a remix plugin

yes I think we could do that, but first let's merge this PR, sorry for the delay...
Note that we also planned to fork dapp-template to the git org remix-project-org, in the meantime.

@drafish
Copy link
Contributor Author

drafish commented Jul 25, 2024

the only question is, can I put dapp-template into remix codebase, even it's not a remix plugin

yes I think we could do that, but first let's merge this PR, sorry for the delay... Note that we also planned to fork dapp-template to the git org remix-project-org, in the meantime.

Hi @yann300 I'v putted dapp-template into remix codebase. Should I submit it in this PR? Or wait until you merge this one, and make another PR?

@ryestew ryestew force-pushed the quick-dapp branch 2 times, most recently from aab19f2 to b2cdf46 Compare August 22, 2024 02:19
@yann300 yann300 merged commit 9f0f83f into ethereum:master Aug 26, 2024
24 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code reviewed PR code has been reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants