ContextProject_RDD

Documents

• Definition of Done

• Sprint backlogs:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

• Sprint retrospectives:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

• Research Documents:

  • Frameworks
  • IDE
  • Static Analysis Tools
  • Hint Generation

• Product Vision (final)

• Product Planning (final)

• Architecture Design Document (final)

• Semantic Database Elements

• Test Report

• Performance Testing Report

• Final Report (final)

All documents can in general be found in the doc folder.

Setup

• Download WebStorm
• Download Nodejs
• Use WebStorm (or Git knowledge) to clone the repo to a local folder
• Run npm install
• Run npm run-script travis to check whether everything works correctly
• Run git submodule init && git submodule update --recursive to make the analytics work

Congratulations, you can now start developing!

To see console output of the extension's background page, enable "Developer mode" in Chrome and click "Inspect view".

If you want to see debug output in the console of the background page, type Logger.setDebug() in the console or add this to src/octopeer-github/main/main.ts.

The next section will continue with applying Static Analysis Tools to WebStorm.

Tooling (SAT)

Installing and activating TSLint:

• Run npm install -g tslint.
• Within WebStorm, open the Settings / Preferences Dialog by
  • (for Windows and Linux) clicking on the 'File' tab and then 'Settings'.
  • (for OS X) clicking on the 'WebStorm' tab and then 'Preferences'.
  • the shortcut: ctrl + alt + s.
• Go to 'Languages & Frameworks' and click on 'TypeScript' and then on 'TSLint'.
• In the area that shows up, select the 'Enable' check box.

The default settings within this enabled area are sufficient, so apply the changes and close the window.

You've now activated TSLint.

Coverage

• The npm test command will generate a coverage-final.json file.
• Run npm run-script coverage to generate a html coverage report of the json coverage file.
• You can now view the coverage report by opening coverage/html/index.html. This html file gives a nice overview of the coverage of the source code.

Building and Installing the Extension

• Run build.sh to build the extension
  • build.sh clean empties the build directory before building
• In the Chrome menu, go to "More Tools" > "Extensions"
• In the top-right, check "Developer mode"
• Click "Load unpacked extension..."
• Select "$PROJECT_FOLDER/build"

The extension is now loaded in Chrome.

Adding new type definitions for dependencies

• For every new dependency, run typings install --ambient --save <package-name>
• The type definitons should now automatically be included via the TypeScript configuration files

Acknowledgments

We would like to thank PixelKit for allowing us to use and modify the lightbulb icon. It was released with the CC Attribution 4.0 licencse.