Skip to content

Comments

Update README with instructions to enable Google People API#853

Merged
elie222 merged 2 commits intoelie222:mainfrom
rafaelsales:patch-1
Oct 17, 2025
Merged

Update README with instructions to enable Google People API#853
elie222 merged 2 commits intoelie222:mainfrom
rafaelsales:patch-1

Conversation

@rafaelsales
Copy link
Contributor

@rafaelsales rafaelsales commented Oct 17, 2025

This API is required for the application to function with Google.

Fixes #705

Summary by CodeRabbit

  • Documentation
    • Updated Google OAuth setup instructions to include a new step: enable the Google People API in the Google Cloud Console.
    • Added surrounding spacing and clarity to the OAuth section to improve readability and ensure users follow the API enablement step when configuring credentials.

This API is required for the application to function with Google.

Fixes elie222#705
@vercel
Copy link

vercel bot commented Oct 17, 2025

@rafaelsales is attempting to deploy a commit to the Inbox Zero OSS Program Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 17, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Added a documentation step to README.md instructing users to enable the Google People API in the Google Cloud Console as part of the Google OAuth credentials setup.

Changes

Cohort / File(s) Change Summary
Documentation: Google OAuth Setup
README.md
Inserted a new step ("6. Enable Google People API in Google Cloud Console") into the Google OAuth credentials instructions, with surrounding blank-line separation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • doc: updated readme #414 — Updates README Google OAuth instructions; directly related to adding the Google People API enablement step.

🐰 I hopped to the README, clear and gay,
I nudged the People API into play.
A tiny step in docs, concise and spry,
Now OAuth can wave a friendlier hi! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "Update README with instructions to enable Google People API" is clear, concise, and directly reflects the main change in the changeset. The modification to README.md adds a new step for enabling the Google People API, and the title accurately captures this primary objective without unnecessary noise or vague terminology.
Linked Issues Check ✅ Passed The PR addresses the core requirement from issue #705 by providing actionable steps to resolve the Google OAuth 500 Internal Server Error. By adding instructions to enable the Google People API, the PR offers a concrete configuration step that users can take to fix the OAuth failure. This directly aligns with the issue's stated goal of providing "actionable steps or fixes so a local deployment can successfully complete Google sign-in and proceed past the OAuth step."
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4f878b and e775da0.

📒 Files selected for processing (1)
  • README.md (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jit-ci
Copy link

jit-ci bot commented Oct 17, 2025

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

@CLAassistant
Copy link

CLAassistant commented Oct 17, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ elie222
❌ rafaelsales
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 45547ea and e4f878b.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
!{.cursor/rules/*.mdc}

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

Never place rule files in the project root, in subdirectories outside .cursor/rules, or in any other location

Files:

  • README.md
*{TASKS,ASSISTANT_CHAT,*.md}

📄 CodeRabbit inference engine (.cursor/rules/task-list.mdc)

*{TASKS,ASSISTANT_CHAT,*.md}: Create task lists in a markdown file in the project root, using TASKS.md or a descriptive name relevant to the feature (e.g., ASSISTANT_CHAT.md), and include a clear title and description of the feature being implemented.
Structure the task list markdown file with sections: Completed Tasks, In Progress Tasks, Future Tasks, Implementation Plan, and Relevant Files.
Update the task list as you progress: mark tasks as completed by changing [ ] to [x], add new tasks as identified, and move tasks between sections as appropriate.
Keep the 'Relevant Files' section updated with file paths, brief descriptions of each file's purpose, and status indicators (e.g., ✅) for completed components.
Add implementation details to the task list markdown file, including architecture decisions, data flow descriptions, technical components needed, and environment configuration.
When working with task lists, regularly update the task list file after implementing significant components, mark completed tasks with [x], add new tasks discovered during implementation, maintain the 'Relevant Files' section, and document implementation details.
When implementing tasks one by one, first check which task to implement next, and after implementing a task, update the file to reflect progress.

Files:

  • README.md
!pages/_document.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

!pages/_document.{js,jsx,ts,tsx}: Don't import next/document outside of pages/_document.jsx in Next.js projects.
Don't import next/document outside of pages/_document.jsx in Next.js projects.

Files:

  • README.md
🪛 markdownlint-cli2 (0.18.1)
README.md

181-181: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: cubic · AI code reviewer
🔇 Additional comments (1)
README.md (1)

176-181: Content addition is appropriate and addresses issue #705.

Adding step 6 to enable the Google People API is the correct fix. The People API is required for the application to successfully complete Google OAuth authentication and retrieve contact/profile information. The step placement in the OAuth setup workflow is logical and follows the existing documentation structure.

Please ensure you've tested this locally by:

  1. Following steps 1–5 as before
  2. Verifying that enabling the People API (step 6) resolves the 500 error mentioned in issue #705
  3. Confirming that the OAuth flow now completes successfully with the API enabled

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@elie222 elie222 merged commit cc4896b into elie222:main Oct 17, 2025
4 of 6 checks passed
@elie222
Copy link
Owner

elie222 commented Oct 17, 2025

Thanks!

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Google OAuth 500 Internal Server Error

3 participants