https://github.com/willin/remix-auth-afdian

爱发电 OAuth 登录 Remix v2 版本。A AfdianStrategy for Remix Auth, based on the OAuth2Strategy
https://github.com/willin/remix-auth-afdian

afdian oauth remix sdk sso

Last synced: 3 months ago
JSON representation

爱发电 OAuth 登录 Remix v2 版本。A AfdianStrategy for Remix Auth, based on the OAuth2Strategy

• Host: GitHub
• URL: https://github.com/willin/remix-auth-afdian
• Owner: willin
• License: apache-2.0
• Created: 2023-10-02T09:38:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-05T06:17:20.000Z (about 1 year ago)
• Last Synced: 2024-04-14T04:55:42.755Z (10 months ago)
• Topics: afdian, oauth, remix, sdk, sso
• Language: TypeScript
• Homepage: https://remix-auth-afdian.willin.wang/
• Size: 164 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AfdianStrategy 

The Afdian strategy is used to authenticate users against a Afdian account. It extends the OAuth2Strategy.

## Supported runtimes

| Runtime    | Has Support |

| ---------- | ----------- |

| Node.js    | ✅          |

| Cloudflare | ✅          |

## Usage

### Create an OAuth application

Follow the steps on [the Afdian（爱发电） documentation](https://afdian.net/p/010ff078177211eca44f52540025c377) to create a new application and get a client ID and secret.

### Create the strategy instance

```ts

import { AfdianStrategy } from "remix-auth-afdian";

let afdianStrategy = new AfdianStrategy(

  {

    clientID: "YOUR_CLIENT_ID",

    clientSecret: "YOUR_CLIENT_SECRET",

    callbackURL: "https://example.com/auth/afdian/callback",

  },

  async ({ accessToken, extraParams, profile }) => {

    // Get the user data from your DB or API using the tokens and profile

    return User.findOrCreate({ email: profile.emails[0].value });

  }

);

authenticator.use(afdianStrategy);

```

### Setup your routes

```tsx

// app/routes/login.tsx

export default function Login() {

  return (

    

      Login with Afdian(爱发电 )

    

  );

}

```

```tsx

// app/routes/auth.afdian.tsx

import type { ActionArgs } from "@remix-run/node";

import { redirect } from "@remix-run/node";

import { authenticator } from "~/auth.server";

export async function loader() {

  return redirect("/login");

}

export async function action({ request }: ActionArgs) {

  return authenticator.authenticate("afdian", request);

};

```

```tsx

// app/routes/auth.afdian.callback.tsx

import type { LoaderArgs } from "@remix-run/node";

import { authenticator } from "~/auth.server";

export async function loader({ request }: LoaderArgs) {

  return authenticator.authenticate("afdian", request, {

    successRedirect: "/dashboard",

    failureRedirect: "/login",

  });

};

```