Getting started


Before embarking on this crazy discord adventure, you will need to follow the steps outlined below to set up a clean and healthy project.

The Dart language

The Mineral framework has been developed entirely in the Dart programming language, so you will need to install it in your development environment first. In order to best install it, please refer to the official documentation.

The Mineral framework

The mineral framework works in 4 main parts which we will describe below :

  • Command line interface (CLI)
  • Core package
  • Basic structure
  • Ecosystem packages

As mentioned above, the Mineral framework provides you with a command prompt that will allow you to quickly design your development files through a question/answer set that will generate a ready-to-use file accordingly.

CLI installation

To install the CLI, please (after installing the Dart language) run the following command in the command prompt of your machine.

dart pub global activate mineral_cli

During the CLI installation, your machine may ask you to add the location of global packages to your environment variables. If you encounter this message or do not have access to the mineral <command> <...params> prefixed command please check your environment variables.

Now that the CLI is installed, you should be able to use the following command that shows you help.

mineral help

Create your first project

Before continuing, please check that git technology is installed on your machine.

Download git

The command you are about to run will initialise a blank project by downloading a remote repository hosted on the GitHub platform, so if git isn't running, the structure cannot be cloned.

See the repository

Now that all the prerequisites are fulfilled, please run the command that will initialise your project below :

mineral create <MyProject>

Congratulations, you have just created your first project under the Mineral framework !