README.md

CSR COLLABORATION APP

This repository contains an application that allows FactSet volunteers to collaborate with CSR learners and learn basic web development mechanisms.

CONTRIBUTE

STACK

These are the main technologies used:

• VueJS 2
• Git
• GitHub
• NodeJS
• Yarn 1
• Vue-cli-service
• Chrome development tools
• ChartJS
• HighCharts
• Axios
• Lodash
• momentJS

ENVIRONMENT SET UP (learners)

1. Install Git for Windows
2. Install NodeJS
3. Install Yarn
4. Install Visual Studio Code or other IDE
5. Register yourself in GitHub, in case you are not

FORK (learners)

• Go to https://github.com/factset/csr-collaboration-app
• Fork project

CHECKOUT (learners)

• Clone locally forked project using git clone https://github.com/factset/csr-collaboration-app.git or using your IDE
• Create new branch locally git checkout -b my-new-feature-branch or using your IDE

INSTALL AND BUILD LOCALLY (learners)

• Execute following commands:

# Install Dependencies
$ yarn install

# Compiles and hot-reloads for development
$ yarn serve

# Compiles and minifies for production
$ yarn build

# Lints and fixes files
$ yarn lint

CHANGE (learners)

• Do any change in the code

COMMIT (learners)

• git commit -m "New: Exciting Feature" or using your IDE

PUSH (learners)

• git push origin my-new-feature-branch or using your IDE

CREATE PULL REQUEST (PR) (learners)

• Create a PR in GitHub, ask for help if you don't know how to do this.

REVIEW (learners and volunteers)

• Volunteer to provide comments on changes.

APPROVE (volunteers)

• Once agreed upon changes PR can be approved and merged.

MERGE (learners)

• Merge in GitHub, ask for help if you are unsure.

EXERCISES (learners)

• Go to Exercises

RESOURCES

• CoinDesk Documentation
• Highcharts
• ChartJS
• Made with Vue.js
• ES2015+ Cheat Sheet
• CoinStats API

Thanks to Alex Barker for the initial setup. Forked from https://github.com/six-edge/vue-highcharts-example