Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Setting up your Project Folder:

A few steps should be taken by the developer before running the initial bm forms init command:

  1. Inside your project folder, create a sub folder that will contain your forms components.
  2. Using the command line, cd into your project folder (not your new forms folder, but the parent project folder) and run npm init. This will setup your package.json file, which is needed to handle the forms plugins.

You should end up with a folder structure similar to this:


Code Block
|--my-project/
|  |--my-forms/
|  |--package.json


You can now move on to using the Forms CLI.

...

After setting up your forms folder, you can then start using the Forms CLI by running the init command.

From your project folder, run the following command:

Code Block
bm forms init

...

This will either be the answerSpace URL, or the location of the JSON definition files within your project folder, depending on what you selected for the first option.

Location of the output folders

This is the location of the folders you want to write both your source components and component distribution file too, as well as where the framework templates will be created. If We recommend you use the defaults, these will be bm-forms-srcdist and templates (only the templates folder will be created initially, until the bm forms create and build steps are ran later)set the path to your "my-forms" folder, as this will keep your project folder well structured.

Note, if you set the Source folder to "my-forms/src" then the next output folders will default to the "my-forms" folder too.

Framework plugin to use

Finally, you'll be asked which framework plugin you wish to use. AngularJS and JSON are currently included by default. Later, we'll talk more about how you can use your own custom Forms CLI plugins.

...

If the defaults are used, you should end up with a folder structure that matches the following:


Eclipse
Code Block
theme
|--my-project/
|  |--.git/
|  |--node_modules/
|  |--my-forms/
|  |  |--templates/
|  |--.blinkmrc.json
|  |--package.json

...