Mobile fix

.github/workflows/build.yml

@@ -3,13 +3,18 @@ name: Build
 on:
   workflow_dispatch:
   push:
-    branches:
-      - main
+    # TODO - uncomment when merging to main branch (!!)
+    # branches:
+    #   - main
   schedule:
     - cron: "0 */3 * * *"
 
 jobs:
   build:
+    strategy:
+      matrix:
+        node-version: [20.10.0]
+
     runs-on: ubuntu-latest
 
     steps:
@@ -18,21 +23,28 @@ jobs:
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: "${{ matrix.node-version }}"
 
       - name: Build
         run: |
           npm install
           npm run build
 
-      - name: Download ICS file
-        run: curl -o dist/basic.ics https://calendar.google.com/calendar/ical/finos.org_fac8mo1rfc6ehscg0d80fi8jig%40group.calendar.google.com/public/basic.ics
+      - name: Setup environment
+        run: gpg --quiet --batch --yes --decrypt --passphrase="$PASSPHRASE" --output calendar-service-account.json calendar-service-account.json.gpg
+        env:
+          PASSPHRASE: ${{ secrets.GOOGLE_SERVICE_ACCOUNT_PASSPHRASE }}
+
+      - name: Get events from Google API
+        run: npm run getEvents
 
       - name: Add CNAME in dist folder
         run: cp CNAME dist
 
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.ACCESS_TOKEN }}
-          publish_dir: dist # Replace 'dist' with the folder containing your built static files
+      # Disable to avoid risking to influence the live environement (even though it should not)
+      # TODO - re-enable when merging to main branch (!!)
+      # - name: Deploy to GitHub Pages
+      #   uses: peaceiris/actions-gh-pages@v3
+      #   with:
+      #     github_token: ${{ secrets.ACCESS_TOKEN }}
+      #     publish_dir: dist

.gitignore

@@ -24,3 +24,7 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# secrets
+calendar-service-account.json
+

README.md

@@ -1,12 +1,16 @@
 # FINOS Calendar
 
-This code builds the page hosted on https://calendar.finos.org , which is also embedded on https://www.finos.org/calendar .
+This code builds the page hosted on https://calendar.finos.org , which is also embedded on https://www.finos.org/calendar , in order to provide a fully hosted solution that shows all events in the [FINOS Community (Google) Calendar](https://calendar.google.com/calendar/embed?src=symphony.foundation_6g70j7s80813djmj9q7gmgdjuc%40group.calendar.google.com&ctz=Europe%2FMadrid) that can be correctly visualised also behind a corporate firewall.
+
+A Github action runs periodically to fetch events using Google APIs (see [src/googleapi2events.js](src/googleapi2events.js)) and renders out a JSON file in `dist/events.json`.
+
+The calendar is visualized in HTML using React and [FullCalendar](https://fullcalendar.io/).
 
 ## Prerequisites
 
 - Node.js and npm installed on your machine.
 
-## Getting Started (work in progress, see https://github.com/finos/calendar/issues/9 )
+## Getting Started
 
 1. Clone the repository:
 
@@ -15,16 +19,36 @@ git clone https://github.com/finos/calendar.git
 cd calendar
 ```
 
+2. Download `calendar-service-account.json` into the project's root folder.
+
+In order to use the Google Calendar API you will need to follow [these 5 steps](https://developers.google.com/workspace/guides/get-started) to generate the necessary credentials. Once you have the credentials store them in the root folder of the project in a file named `calendar-service-account.json`.
+
+### Encrypting Google Service Account key
+
+```
+gpg --symmetric --cipher-algo AES256 calendar-service-account.json
+```
+
 ### Install the dependencies:
 
 ```bash
 npm install
 ```
 
+### Import events from Google API
+
+```bash
+npm run getEvents
+```
+
 ### Run development server
 
 ```bash
-npm run dev
+npm start
 ```
 
 Open browser to `http://localhost:5173/`.
+
+### Live environment
+
+https://calendar.finos.org is served by Github Pages and deployed by the [build.yml](.github/workflows/build.yml) Github Action.