Synapse React Client Developer Documentation

Technologies Used

ES6

React

Typescript

Development

Setup the repository

1. Fork the Sage-Bionetworks Synapse-React-Client into your own GitHub account: https://help.github.com/articles/fork-a-repo Synapse-React-Client repository 

2. Clone the Synapse-React-Client project down to your computer: git clone https://github.com/[YOUR GITHUB NAME]/Synapse-React-Client.git

3. Change into the proper directory with: cd Synapse-React-Client

4. Set up upstream with: git remote add upstream https://github.com/Sage-Bionetworks/Synapse-React-Client

5. Fetch and merge changes from the Sage Bionetworks repo, which was named upstream: 

   git fetch upstream

Setup the environment

1. Download Visual Studio Code

   1. There are many extensions used in the project, all of which you can opt-out of if desired, they are used to speed up the development process, but its entirely up to the developer to use them or not. Extensions used:

      1. Chrome Debugger

      2. tslint

      3. prettier

2. Download Node.js

Dependencies