UoaWDCC / ASPA-EnrollmentForm

6 stars 1 forks source link

[ASPA-011] GoogleSheets API set up completed #2

Closed lucas2005gao closed 4 years ago

lucas2005gao commented 4 years ago

Issue: The Google Sheets API credentials needs to be set up before we can make API calls. Solution: The /vendor/ folder is set up locally for the API call using composer, and Google Sheets API credentials are set up for calling the API. Other stories will need to install composer and run "composer install" command in the project folder, and have credentials.json ready to call the Google Sheets API. Risk Area: The /vendor/ folder and credentials.json needs to be present to call the API. Therefore if other stories run into Errors then install vendor and download credentials.json Reviewed by: Emily, Martin, Will, Raymond, Jiaru

lucas2005gao commented 4 years ago

It is recommended by Composer that we don't upload the dependencies on to Github. It is standard practice for developers to use package managers to download the required dependencies for a project too. The vendor folder is 46MB in size, so I will prefer not to upload it to Github as it will be easier to work with over time. Plus, this is also a part of learning the PHP framework.

lucas2005gao commented 4 years ago

I have written up the instructions on how to install Composer and install the required dependencies, as well as where to download credentials.json. See the link below https://docs.google.com/document/d/12gQFGppZIV2cbQnOcgkKMs8szKhBsIAE42iEvRt1NQk/edit?usp=sharing