Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/art2url/git-oauth-bridge

🗄️ A lightweight Node.js + Express server that handles GitHub OAuth authentication, exchanges authorization codes for access tokens, and retrieves user information. Perfect for integrating GitHub login into your apps.
https://github.com/art2url/git-oauth-bridge

cors express github nodejs oauth server

Last synced: about 10 hours ago
JSON representation

Host: GitHub
URL: https://github.com/art2url/git-oauth-bridge
Owner: art2url
License: mit
Created: 2025-02-08T18:22:26.000Z (2 days ago)
Default Branch: main
Last Pushed: 2025-02-08T18:49:38.000Z (2 days ago)
Last Synced: 2025-02-08T19:29:31.512Z (2 days ago)
Topics: cors, express, github, nodejs, oauth, server
Language: JavaScript
Homepage:
Size: 15.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# GitHub OAuth Server

This repository provides a simple Node.js + Express backend that handles GitHub OAuth authentication. It exchanges the GitHub authorization code for an access token and retrieves user information.

## Features
- Handles GitHub OAuth authentication
- Exchanges authorization code for access token
- Retrieves authenticated GitHub user's information
- Configurable via environment variables
- CORS-enabled for integration with front-end applications

## Prerequisites
- Node.js and npm installed on your machine
- A GitHub OAuth application with Client ID and Client Secret

## Setup

1. **Clone the Repository:**
```bash
git clone https://github.com/art2url/git-oauth-bridge.git
cd git-oauth-bridge
```

2. **Install Dependencies:**
```bash
npm install
```

3. **Retrieve GitHub OAuth Credentials:**
- Go to [GitHub Developer Settings](https://github.com/settings/developers).
- Click on **"New OAuth App"**.
- Fill in the required fields:
- **Application Name:** Your app's name.
- **Homepage URL:** Your app's homepage (e.g., `http://localhost:3000`).
- **Authorization Callback URL:** `http://localhost:3000/auth/github/callback` (or your actual callback URL).
- After creating the app, you will see **Client ID** and **Client Secret**.

4. **Configure Environment Variables:**
Create a `.env` file in the root directory with the following content:
```env
GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret
PORT=3000 # Optional, defaults to 3000
```

5. **Run the Server:**
```bash
node server.js
```

## API Endpoints

### POST `/auth/github`
Handles GitHub OAuth authentication by exchanging the authorization code for an access token and retrieving user information.

#### Request Body:
```json
{
"code": ""
}
```

#### Successful Response:
```json
{
"access_token": "",
"github_username": ""
}
```

#### Error Responses:
- **400 Bad Request:** If the authorization code is missing or invalid.
- **500 Internal Server Error:** If there's an issue during the OAuth flow.

## License
This project is licensed under the MIT License.

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.