Skip to content

CloudExecution

Jump to bottom
gg edited this page Jul 1, 2023 · 1 revision

Mina Developer Container on Gitpod

This step-by-step documentation, we will walk you through the process of setting up MDC using Gitpod as a remote development and execution platform. Gitpod is an open-source Kubernetes application that offers prebuilt, collaborative development environments in your browser, powered by VS Code.

Step 1: Sign up for Gitpod

  • Open your browser and navigate to gitpod.io
  • Click on the "Sign up" button to create a new Gitpod account
  • Follow the on-screen instructions to complete the sign-up process using your Github account.

Step 2 (Optional): Fork the Mina Developer Container Repository

  • Visit the Mina Developer Container repository: https://github.com/rhvall/MinaDevContainer
  • Click on the "Fork" button in the top-right corner of the repository page
  • This will create a copy of the repository under your GitHub account
  • NOTE: This step is optional, you can execute MDC directly using this button: Open in Gitpod

Step 3: Launch MDC in Gitpod

  • Open your browser and navigate to gitpod.io
  • Click on the "Open a repository" button
  • In the search bar, enter the URL of your forked Mina Developer Container repository
  • Select your repository from the search results
  • Gitpod will start initializing the environment, which may take a few moments
  • Once the environment is ready, you will be redirected to a web interface of VSCode.

Step 4: Explore the MDC Workspace

  • The Gitpod workspace will open in your browser, providing you with a ready-to-go environment for Mina development
  • Familiarize yourself with the workspace layout, which includes a file explorer, terminal, and integrated VS Code editor
  • Take a moment to browse through the pre-installed software and tools available in the workspace, the list is here.

Step 5: Compile, Deploy, and Run Mina's ZKApps

  • In the VSCode terminal, the default folder is /workspace/MinaDevContainer/Dependencies/zkAppExamples directory
  • Use the provided commands to compile your zkApps examples:
    • Example 1: npm run main01
    • Example 2: npm run main02
    • Example 3: npm run main03
  • Follow the output and logs in the terminal to monitor the compilation, deployment, and execution process
  • NOTE: Check the package.json file inside /workspace/MinaDevContainer/Dependencies/zkAppExamples/package.json, it contains all main0X examples you can test.

Step 6: Customize Your Dev/Test Environments

  • MDC offers replicable dev/test environments that you can customize as per your requirements
  • Use the Gitpod workspace to explore and modify the configuration files and settings
  • Test different configurations and settings to match your specific development needs.

Step 7 (Optional): Collaborate with Others

  • Gitpod allows for collaborative development, enabling you to share your workspace with others
  • Use the built-in collaboration features to invite collaborators and work together on Mina development projects.

Congratulations! You have successfully set up the Mina Developer Container using Gitpod as your remote development and execution platform. You can now simplify your workflow, explore Mina's ZKApps, and customize your dev/test environments to unleash your creativity. Happy developing!!

Clone this wiki locally