Project name

Requirements

• Windows > 7
• PowerShell > 5

Setting up your local environment

Install scoop

Run the following commands from your PowerShell to install scoop:

$env:SCOOP='D:\dev\scoop'
[Environment]::SetEnvironmentVariable('SCOOP', $env:SCOOP, 'User')
iwr -useb get.scoop.sh | iex

Install Git

Run the following command from your PowerShell to install Git:

scoop install git

Install Node.js

Run the following command from your PowerShell to install Node.JS:

scoop install nodejs-lts

Project instalation

Open the folder where you want to install project from your PowerShell, then run the following command:

ssh://[email protected]:7999/ma/annotations.git

Open project folder:

annotations

Install npm dependencies with the following command:

npm install

Project commands

Build project

Development Workflow

Please read this document before you start Development Workflow

Coding Style

There are the style guidlines for coding in this project.

• Write in Project style Typescript.
• Use capitalization scheme to name your files
  • When the module itself is a class like BrowserWindow, use PascalCase.
  • When the module is a set of APIs, like globalShortcut, use camelCase.
  • For React components use .tsx file extension.

You can run npm run lint to show any style issues detected by eslint.