supermemoryai / supermemory

Build your own second brain with supermemory. It's a ChatGPT for your bookmarks. Import tweets or save websites and content using the chrome extension.
https://supermemory.ai
MIT License
6.22k stars 594 forks source link

Update SETUP-GUIDE.md #257

Closed nishantmete closed 1 week ago

nishantmete commented 2 weeks ago

Improve OAuth Setup Documentation

Overview

This pull request aims to enhance the setup guide for the Supermemory web application by providing clearer and more detailed instructions for setting up Google OAuth credentials.

Changes

The changes in this pull request focus on improving the setup guide for the Supermemory web application, specifically the instructions for creating Google OAuth credentials. The updated guide provides clearer and more detailed steps to help developers set up the necessary credentials for the authentication system, which uses NextAuth.js. The key changes include: 1. Clarifying that the Google OAuth credentials are required for the `auth.js` (NextAuth) functionality, rather than just stating they are "needed for auth.js". 2. Providing more specific guidance on setting the redirect URL, including the recommended value for development (`http://localhost:3000/api/auth/callback/google`) and a note that the redirect URL can be set to the deployment domain when deploying the application. These changes aim to make the setup process more straightforward and easier to follow for developers setting up their own instances of the Supermemory application.

✨ Generated with love by Kaizen ❤️

Original Description
kaizen-bot[bot] commented 2 weeks ago

🔍 Code Review Summary

All Clear: This commit looks good! 👍

📊 Stats

🟠 Refinement Suggestions:

These are not critical issues, but addressing them could further improve the code:

Documentation Update (1 issues)
1. The documentation for setting up the Google OAuth credentials is missing from the SETUP-GUIDE.md file. ------ 📁 **File:** `SETUP-GUIDE.md:20` ⚖️ **Severity:** 7/10 🔍 **Description:** Providing clear instructions for setting up the necessary credentials is crucial for new developers to be able to successfully run the application. 💡 **Solution:** Add a new section in the SETUP-GUIDE.md file that outlines the steps for creating Google OAuth credentials and configuring the redirect URL. **Current Code:** ```python ``` **Suggested Code:** ```python 1. You need to create OAuth credentials for Google which are needed for auth.js (nextauth). Visit https://developers.google.com/identity/protocols/oauth2 to learn more and https://console.cloud.google.com/apis/dashboard to create a new project and OAuth credentials. You need to set the redirect URL to `http://localhost:3000/api/auth/callback/google` for development. You can also set the redirect URL to your own domain if you are deploying the app. ```


✨ Generated with love by Kaizen ❤️

Useful Commands - **Feedback:** Reply with `!feedback [your message]` - **Ask PR:** Reply with `!ask-pr [your question]` - **Review:** Reply with `!review` - **Explain:** Reply with `!explain [issue number]` for more details on a specific issue - **Ignore:** Reply with `!ignore [issue number]` to mark an issue as false positive - **Update Tests:** Reply with `!unittest` to create a PR with test changes