Skip to content

Docs/auth: Added Basic Google Auth docs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
notKeion wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs/auth: Added Basic Google Auth docs #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fede240
ignore lock files
notKeion Feb 23, 2026
a1ee147
Added further instructions for google auth
notKeion Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
/.pnp
.pnp.js
.yarn/install-state.gz
yarn.lock
package-lock.json

# testing
/coverage
Expand Down
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,18 @@ To get a local copy up and running follow these simple steps.
npm install
```
3. Create a `.env.local` file and add your MongoDB URI and NextAuth URL
```
MONGO_URI=your_mongodb_uri
```sh
MONGO_URI=your_mongodb_uri # This can be obtained from MongoDB Atlas after creating a cluster and database.
NEXTAUTH_URL=http://localhost:3000

# Google OAuth credentials (for Google authentication)
GOOGLE_CLIENT_ID="your_google_client_id" # This can be obtained from the Google Cloud Console after creating a project and OAuth 2.0 credentials.
GOOGLE_CLIENT_SECRET="your_google_client_secret" # This can also be obtained from the Google Cloud
```
Ensure when you create the google auth credentials, you set the authorized redirect URI to:
- `http://localhost:3000/api/auth/callback/google` for local development.
- `https://your-deployment-url/api/auth/callback/google` for production.

4. Run the development server
```sh
npm run dev
Expand Down