embarklabs
/
embark
mirror of https://github.com/embarklabs/embark.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
embark/site/source/docs/dashboard.md

2.3 KiB
Raw Permalink Blame History

title: Using the dashboard layout: docs

Embark provides a very useful dashboard view that aims to make it easier for developers to keep track of things, such as running services, compilation and deployments. In this guide, we'll take a closer look at the dashboard and its features.

Overview

Embark spins up the dashboard view automatically for us, whenever we run embark run inside an Embark project. Here's what it looks like:

Dashboard

The dashboard is separated into different sections, each with their own responsibility. The sections are:

  • Contracts - This section shows you not only all the Smart Contracts within your project, but also their status on whether they are being deployed at the moment or not. Notice that, as we make changes to our Smart Contracts, the dashboard will reflect the automatic redeployment in this section as well, making it very easy to stay on top of things.

  • Environment - This is the name of the environment we're running Embark in at the moment. If we don't specify an environment when running embark run, Embark will default to development.

  • Status - As mentioned, Embark watches for changes in our application's source code and will recompile, rebuild and redeploy components accordingly. The status section tells us what status Embark is currently in. Which could be one of the following:

    • Compiling - Compiles application's Smart Contracts
    • Building - Builds application's front-end
    • Ready - Ready and IDLE

  • Available Services - This section displays all services available to our application. If a service is down or unreachable, it will show up in red.

  • Logs and Console - While the logs section simply prints out all of Embark's output, the console can be used to either interact with our application's Smart Contracts or Embark itself. Use the help command to get a list of all available commands supported by Embark's console, or head over to our guide on Using the the console to learn more.

Running without a dashboard

Embark can be run without spinning up the dashboard view using the --nodashboard option. Head over to our guide on running apps for more information.