https://github.com/lit-protocol/lit-login-server
https://github.com/lit-protocol/lit-login-server
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lit-protocol/lit-login-server
- Owner: LIT-Protocol
- Created: 2023-02-01T18:31:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-20T22:46:06.000Z (about 1 year ago)
- Last Synced: 2025-05-20T23:33:00.979Z (about 1 year ago)
- Language: JavaScript
- Size: 483 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lit Login Server
This server is dedicated to handling social login flows when authenticating with PKPs tied to social login accounts like Google and Discord.
The server is live at [https://lit-login-server.herokuapp.com/](https://lit-login-server.herokuapp.com/).
## 💻 Dev setup
Note: The server uses Redis to store temporary data. You'll need to [install Redis](https://redis.io/docs/getting-started/) on your machine and run it in the background.
1. Clone this repo and install dependencies:
```bash
git clone https://github.com/LIT-Protocol/lit-login-server
cd lit-login-server
pnpm install
```
2. Create `.env` in the root directory, and add the following environment variables:
```bash
GOOGLE_CLIENT_ID=355007986731-llbjq5kbsg8ieb705mo64nfnh88dhlmn.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=
DISCORD_CLIENT_ID=1052874239658692668
DISCORD_CLIENT_SECRET=
PORT=3300
DOMAIN=localhost:3300
ORIGIN=http://localhost:3300
```
3. Start your development server:
```bash
pnpm dev
```
Make sure that your Redis server is also running.
## 🚀 Deployment
The server is hosted on Heroku. You'll need access to the Lit Protocol Heroku account to manage the server.
## 🔁 Available Endpoints
| HTTP Verb | Path | Description |
| --------- | ---------------------- | ------------------------------------------------------------------------------------ |
| GET | /auth/discord | Redirect user to Discord authorization URL |
| GET | /auth/google | Redirect user to Google authorization URL |
| GET | /auth/discord/callback | Handles callback from Discord then redirects user back to the specified redirect URI |
| GET | /auth/google/callback | Handles callback from Google then redirects user back to the specified redirect URI |
## 🎈 Error Codes
If an error occurs, the server will redirect to an error page (hosted by either the server or the initial app that is calling the endpoints) and append an error code to the URL.
| Error Code | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------- |
| invalid_params | Missing `state` and/or `app_redirect` param in the request URL when calling `/auth/discord` or `/auth/google` |
| missing_state | Missing `state` param in the callback request URL |
| missing_redirect | Unable to retrieve the `app_redirect` from Redis during the OAuth callback flows |
| invalid_access_token | Unable to verify Discord authorization code and retrieve the Discord access token |
| token_error | Unable to verify Google authorization code and get the Google ID token |
Additional error codes may appear at the `/auth/discord/callback` endpoint. These are returned by Discord and are documented [here](https://discord.com/developers/docs/topics/opcodes-and-status-codes).