From 3788e92b78ad2e783c5f8ffffb15d942a54ddb6f Mon Sep 17 00:00:00 2001 From: thekeviv Date: Thu, 15 Apr 2021 19:01:13 +0000 Subject: [PATCH] Added more details on info about obtaining google api creds --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e4a4a4cad8..71da21a4af 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Here is what you need to be able to run Calendso. * PostgreSQL * Yarn _(recommended)_ -You will also need Google API credentials. You can get this from the [Google API Console](https://console.cloud.google.com/apis/dashboard). Simply create a new project, set the OAuth to use the calendar.events read and write permissions, and then set the callback URL to `/api/integrations/googlecalendar/callback`. +You will also need Google API credentials. You can get this from the [Google API Console](https://console.cloud.google.com/apis/dashboard). More details on this can be found below under the [Obtaining the Google API Credentials section](#Obtaining-the-Google-API-Credentials). ### Development Setup @@ -85,12 +85,29 @@ See the [open issues](https://github.com/calendso/calendso/issues) for a list of Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + 1. Fork the project 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the branch (`git push origin feature/AmazingFeature`) 5. Open a pull request + +## Obtaining the Google API Credentials + +1. Open [Google API Console](https://console.cloud.google.com/apis/dashboard). If you don't have a project in your Google Cloud subscription, you'll need to create one before proceeding further. Under Dashboard pane, select Enable APIS and Services. +2. In the search box, type calendar and select the Google Calendar API search result. +3. Enable the selected API. +4. Next, select OAuth consent screen from the side pane. Select the app app type (Internal or External) and enter the basic app details on the first page. +5. In the second page on Scopes, select Add or Remove Scopes. Search for Calendar.event and select the scope with scope value `.../auth/calendar.events` and select Update. +6. Next, under Test Users, add the Google account(s) you'll using. Make sure the details are correct on the last page of the wizard and your consent screen will be configured. +7. Now select Credentials from the side pane and then select Create Credentials. Select the OAuth Client ID option. +8. Select Web Application as the Application Type. +9. Under Authorized redirect URI's, select Add URI and then add the URI `/api/integrations/googlecalendar/callback` replacing CALENDSO URL with the URI at which your application runs. +10. The key will be created and you will be redirected back to the Credentials page. Select the newly generated client ID under OAuth 2.0 Client IDs. +11. Select Download JSON. Copy the contents of this file and paste the entire JSON string in the .env file as the value for GOOGLE_API_CREDENTIALS key. + + ## License