Overview

The Projects page displays a list of all your projects, each represented by a card showing its name and location. Key features include:

View Projects

See all your projects at a glance with clear project cards

Create Projects

Create new projects with customizable templates

Import Projects

Import existing projects seamlessly

Manage Projects

Manage individual projects with detailed controls

Creating a New Project

1

Start project creation

Click the “Create New Project” button in the top right corner.

2

Select project type

In the modal that appears, select the “New Project” tab.

3

Configure project details

Fill in the project details:

  • Project Name: Enter a unique name for your project
  • Project Path: Choose where to save your project on your local machine
  • Frontend Type: Select your preferred frontend framework (e.g., React, Vue, Svelte)
  • Canister Type: Choose the backend canister type (e.g., Motoko, Rust)
4

Create the project

Click “Create” to set up your new project.

When creating a new project, use a descriptive name that reflects its purpose or main functionality. This will make it easier to identify and manage your projects as your portfolio grows.

Importing an Existing Project

1

Start import process

Click the “Create New Project” button.

2

Select import option

Select the “Import Existing” tab in the modal.

3

Configure import details

Enter the project details:

  • Project Name: Provide a name for the imported project
  • Project Path: Select the directory of your existing project
4

Complete import

Click “Import” to add the project to DFX Dashboard.

Before importing, ensure your existing project’s structure is compatible with the current version of dfx to avoid potential issues during the import process.

Managing Projects

Take control of your projects with our powerful management tools.

Each project card on the main Projects page has two primary actions:

Launch in Code Editor

  • Click “Open With” to see a list of installed code editors on your system
  • Select your preferred editor to open the project
  • Supports popular editors like VS Code, WebStorm, Sublime Text, and more

Be cautious when editing the dfx.json file directly. Incorrect modifications can lead to project configuration issues.

Project List Features

Navigate and organize your projects effortlessly with these built-in features:

Search

Use the search bar to quickly filter projects by name

Project Count

The top of the page displays the total number of projects for easy reference

Pagination

For larger project collections, use pagination controls to navigate between pages

Best Practices

Troubleshooting

Additional Resources

Ready to start working with canisters? Continue to the Canisters page to learn about managing your deployed code.