Appearance

Quick Start Guide ​

Welcome to the DFX Dashboard, your all-in-one tool for managing Internet Computer projects. This guide will walk you through the essential features to help you start developing quickly and efficiently.

Installation ​

Before diving into the features, ensure you have the DFX Dashboard installed on your system. For detailed installation instructions, please refer to our Installation Guide.

TIP

Make sure you have the latest version of the DFX Dashboard installed to access all features and improvements.

Dashboard Overview ​

Upon launching the DFX Dashboard, you'll see a sidebar with the following main sections:

The top right corner shows your active identity and provides options for refreshing, closing, and adjusting display settings.

TIP

Take a moment to familiarize yourself with the layout. The sidebar is your main navigation tool for accessing different features of the Dashboard.

1. Setting Up Your Environment ​

Configuring Settings ​

  1. Navigate to the Settings page.
  2. Choose between bundled DFX and system DFX.
  3. Configure important environment variables like CANISTER_CANDID_PATH and DFX_VERSION.

WARNING

Ensure you understand the implications of changing environment variables, as they can affect your project's functionality.

2. Managing Projects ​

  1. Go to the Projects page.
  2. Click Create New Project to start a new Internet Computer project.
  3. Fill in the project details:
    • Project name
    • Project path
    • Frontend type (e.g., React, Vue)
    • Canister type (e.g., Motoko, Rust)
  4. Use the Open With button to launch your project in your preferred code editor.

TIP

Use descriptive names for your projects to easily identify them in the dashboard.

3. Working with Canisters ​

  1. Navigate to the Canisters page to view all canisters across your projects.
  2. Use the Canister Actions button to:
    • Build canisters
    • Deploy canisters
    • Start or stop canisters
    • View canister status
  3. Utilize the command interface for advanced canister operations.

WARNING

Be cautious when performing actions like stopping or deleting canisters, as these can affect your application's functionality.

4. Managing Identities ​

  1. Visit the Identities page.
  2. Click Create New Identity to add a new identity.
  3. Choose between creating a new identity, importing an existing one, or using Internet Identity.
  4. Use the Select button to set an active identity for your operations.

TIP

Use different identities for development and production environments to enhance security.

5. Handling Cycles ​

  1. On the Cycles page, view your current cycle balance.
  2. Use the tabs to:
    • Convert ICP to cycles
    • Transfer cycles to other principals
    • Top up canisters with cycles

WARNING

Always double-check recipient addresses and amounts when transferring cycles, as these transactions cannot be reversed.

6. Configuring Networks ​

  1. Access the Network page to view and edit your networks.json configuration.
  2. Modify the JSON directly in the editor to add or change network settings.
  3. Define custom networks for different development stages or environments.

TIP

Use descriptive names for custom networks to easily identify their purpose within the Dashboard.

7. Reviewing Logs ​

  1. Check the Logs page for a history of commands executed in the Dashboard.
  2. Use the action buttons to:
    • View command outputs
    • Re-execute commands
    • Copy command text

TIP

Utilize the search and filter options to quickly find specific commands in your history.

8. Checking Dashboard Information ​

  1. Visit the About page for version information on:
    • DFX Dashboard
    • DFX
    • DFXVM
  2. Use the provided links to:
    • Make feature requests
    • Report bugs
    • Review release notes

Best Practices for Getting Started ​

TIP

Optimize your DFX Dashboard experience:

  • Start by creating a small test project to familiarize yourself with the workflow.
  • Regularly check for updates to the DFX Dashboard and related tools.
  • Use the Cycles page to monitor and manage your resources effectively.
  • Leverage the Logs page to track and repeat common operations.
  • Regularly review and update your network configurations.
  • Backup important project data and configurations regularly.
  • Explore each section of the Dashboard to discover features that can enhance your productivity.

Troubleshooting Common Issues ​

WARNING

Watch out for these common pitfalls:

  • If commands fail, check your active identity and ensure it has the necessary permissions.
  • For network-related issues, verify your internet connection and firewall settings.
  • If canisters aren't deploying, check your cycle balance and network configuration.
  • For unexpected behavior, try refreshing the Dashboard or restarting the application.
  • Always keep your DFX and DFXVM versions up to date to avoid compatibility issues.

Additional Resources ​

Remember, the DFX Dashboard is designed to streamline your Internet Computer development workflow. Don't hesitate to explore each section in depth as you become more comfortable with the tool.

For more detailed information on each feature, click the links provided in the guide.