Setting up your Project Folder:
A few steps should be taken by the developer before running the initial bm forms init command:
- Inside your project folder, create a sub folder that will contain your forms components.
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:
You can now move on to using the Forms CLI.
Initialising the Builder Properties
After setting up your forms folder, you can then start using the Forms CLI by running the init command:
bm forms init
This will initialise the project, which will set up your blinkmrc.json file.
You will prompted to answer a handful of questions:
Source of your forms definition
This will either be the answerSpace form, or your own JSON definition.
Location of this definition
This will either be the answerSpace URL, or the location of the JSON definition files within your project folder.
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 you use the defaults, these will be bm-forms-src, dist and templates (only the templates folder will be created initially, until the bm forms create and build steps are ran later).
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:
|--my-project/ | |--.git/ | |--node_modules/ | |--my-forms/ | | |--templates/ | |--.blinkmrc.json | |--package.json
Next Step
Create & Build: Creating the Library Source and Building the Distribution File