akash-jivani

####Prerequisite:

• Download & Install nodejs

• Download & Install yarn (Depends on Node.js)

• Download & Install JRE 8u201 (We have tested with 8u201, but it will probably work with others if you have a newer version.)

• Setup node, yarn, & java in enviroment path

• Download & Install a Code Editor. We are using VSCode

• Run the following commands to set your registry to our internal artifactory server. This only needs to be done once per machine:

  • yarn config set registry https://artifacts.microchip.com/artifactory/api/npm/npm/
  • npm config set registry https://artifacts.microchip.com/artifactory/api/npm/npm/

• For further information please see the Workflow

####Setup

• cd to the project root
• run the following commands:
  • yarn install
    • this downloads all of the project dependencies to your machine
  • yarn build-run-dir
    • this builds a run directory in your project
    • if download fails, checkout and build Scripted Content Framework and copy the generated run folder to your project's root directory
• create a file called peripheral.json in the config directory. Place a JSON object copied from the device and peripheral you wish to use for this project

#####Compile & Build

• yarn create-auto-module
  • Generates a moduleConfig.json file and creates a set of files in the generated_module directory specific to the data in config/peripheral.json. -moduleConfig.json can now be modified to customize your project.
• yarn build
  • Builds the project and distributes the output files to the run directory. This also runs create-auto-module as part of the build process
• yarn start
  • Creates a watcher on the project that detects changes in the source files. When a change is detected, a short compilation is performed and the new files are distributed. It is intended to speed up the design process.

#####Unit Tests

• yarn test
  • Triggers all the unit test cases specified by any file ending in .test.ts
  • Unit test report is available at coverage/lcov-report/index.html