Skip to content

Add instructions for setting up GitHub Provider in README #24

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add instructions for setting up GitHub Provider in README #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,25 @@ If you want google login, you'll need to setup a google project and create some

### Setting up Github Provider

TODO
If you want GitHub login, you'll need to set up a GitHub OAuth application and create some keys:

1. https://github.com/settings/developers
2. create a new OAuth app
3. fill in the required fields:
- **Application Name:** Your application's name.
- **Homepage URL:**
- http://localhost:3000
- https://your-domain.com
- **Authorization Callback URL:**
- http://localhost:3000/api/login/github/callback
- https://your-domain.com/api/login/github/callback
4. Click "Register Application" to create your OAuth app.
5. Copy your **Client ID** and **Client Secret**.

6. Set your GitHub id and secret inside of .env

- **GITHUB_CLIENT_ID**
- **GITHUB_CLIENT_SECRET**

## Contributing

Expand Down