feat: prepare data script + pull data into google spreadsheet

.gitignore

@@ -1 +1,8 @@
-*.backup
+*.backup
+/.env
+# Dependency directories
+node_modules/
+/.idea/
+/data/
+/credentials.json
+/token.json

README.md

@@ -1,11 +1,44 @@
-Metrics
-=======
+# MobilityData metrics
+[Click here to view metrics dashboard](https://docs.google.com/spreadsheets/d/e/2PACX-1vRsOds1l3nNCntabcxqOdvTrVmK1nWjKAsrEoN5gCxB4rqDwrG3j2dDeWgx5pI6m24UGoiG1631fajI/pubhtml)
 
-The metrics project to monitor KPIs on repos
+## Repositories
+This dashboard gives information regarding the following repositories:
+* [MobilityData/gtfs-validator](https://www.github.com/MobilityData/gtfs-valdiator)
+* [MobilityData/gbfs](https://www.github.com/MobilityData/gbfs)
+* [MobilityData/transit](https://www.github.com/MobilityData/transit)
+* [NABSA/gbfs](https://www.github.com/NABSA/gbfs)
+* [google/transit](https://www.github.com/google/transit)
 
-![image](https://user-images.githubusercontent.com/55884852/101205625-e3ef1900-363b-11eb-9adf-125910ee1263.png)
+## Implementation
+Different scripts are implemented in this repository. Their execution in the following order enables rendering of the metrics dashboard.
+* [FetchRawData.js](/src/scripts/FetchRawData.js) fetches raw data from the Github repositories;
+* [AggregateData.js](/src/scripts/AggregateData.js) aggregates the data previously retrieved for future rendering;
 
-### About
+## Automation
+This dashboard is updated on a daily basis at 10AM (GMT-4) via a Google Cloud Build that is triggered by a pub/sub message.
 
-This is your project's README.md file. It helps users understand what your
-project does, how to use it and anything else they may need to know.
+Note that the update of the dashboard will fail it all operations are not completed within 1200s (20 mins).
+
+## Indicators
+
+- comment's dates by months and quarter of the year
+- issue creation date by months and quarter of the year
+- pull request merge date by months and quarter of the year
+- pull request creation date by months and quarter of the year
+- external comments dates by months and quarter of the year
+- forks creation dates by months and quarter of the year
+- repository starring dates by months and quarter of the year
+- repository commit dates by months and quarter of the year
+- number of new issue authors by months and quarter of the year
+- number of new pull request authors by months and quarter of the year
+- number of new commit authors by months and quarter of the year
+- number of open issues
+- number of open pull requests
+
+## Run
+
+### Locally
+
+- Make sure that `GH_TOKEN` is defined at in a file named `.env` located at the root of the project
+- run `node src/scripts/FetchRawData.js`: this script will fetch raw data from Github and save it under `data/raw_data.json` 
+- run `node src/scripts/AggregateData.js`: this script will aggregate data from the previous script and save all metrics by month under `data/metrics.json`

cloudbuild_refresh_data.yaml

@@ -0,0 +1,23 @@
+steps:
+  - name: node
+    entrypoint: npm
+    args: ['install']
+  - name: node
+    entrypoint: npm
+    args: ['run', 'fetch']
+    timeout: 1200s
+    env:
+      - 'GH_TOKEN=$_GH_TOKEN'
+  - name: node
+    entrypoint: npm
+    args: ['run', 'aggregate']
+  - name: node
+    entrypoint: npm
+    args: ['run', 'refresh']
+    timeout: 1200s
+    env:
+    - 'SPREADSHEET_ID=$_SPREADSHEET_ID'
+    - 'CREDENTIALS=$_CREDENTIALS'
+    - 'TOKEN=$_TOKEN'
+timeout: 1200s
+