BYOR Service

Backend server that loads data from multiple services

Prerequisites

1. NodeJS and NPM
2. Google Sheets API credentials. If you do not have one, please follow this tutorial

Installation

1. Clone the repo

   git clone https://github.com/cip-core-mirrors/byor-service.git
   

2. Install NPM packages

   npm install

3. Provide these information in environment variables :

   Name	Description	Default value
   GOOGLE_CLIENT_EMAIL	Email of the Google account used
   GOOGLE_PRIVATE_KEY	Private key of the Google account used
   PORT	Port the server listens to	3000
   POSTGRESQL_HOST	PostgreSQL server host
   POSTGRESQL_PORT	PostgreSQL server port
   POSTGRESQL_DATABASE	PostgreSQL database
   POSTGRESQL_USER	PostgreSQL user
   POSTGRESQL_PASSWORD	PostgreSQL user password

If Google-related environment variables are not provided, the /spreadsheet endpoint will not be available.

Start server

npm run start

The server will be launched and will listen at port 3000 by default (see http://localhost:3000)

Please note that the server can only access to Spreadsheets that it has access to (ie. shared access or public)