Authlink

Authlink is a developer tool that provides an OAuth2 implementation for integrating Guilded as a login medium.

What is Authlink?

Authlink is an OAuth2 service for Guilded, built under the GuildedAPI GitHub organization. It provides an OAuth2 implementation that enables applications to accept Guilded accounts as a login method. The project includes publicly hosted API documentation at authlink.app/dev/docs, a demonstration app written in Remix, and a NextAuth integration package for Next.js applications. The service runs on Node.js.

Key Features

• Guilded OAuth2 — Implements the OAuth2 protocol so applications can accept Guilded accounts as a login method.
• API documentation — Developer docs are available at authlink.app/dev/docs, explaining how to set up a client and call the OAuth endpoints.
• Remix demonstration app — The GuildedAPI/authlink-demo repository contains a working example built with Remix that shows the full login flow.
• NextAuth integration — The next-auth-guilded package adds Guilded as a provider in NextAuth.js setups for Next.js apps.
• Node.js scripts — The project uses npm commands: npm install, npm run dev, npm run build, and npm start.
• Auto-reloading dev server — Running npm run dev watches files and reloads automatically during development.

Who should use Authlink?

• Next.js developers who want to add Guilded sign-in to an app can use the next-auth-guilded package instead of writing the OAuth exchange manually.
• Remix developers can run the demonstration app as a reference for how Guilded OAuth redirects, callbacks, and sessions work.
• Guilded bot and community developers who maintain a website or dashboard can use Authlink to let members log in with their Guilded account.

What can you do with Authlink?

• Add Guilded login to a Next.js app: Import next-auth-guilded into a NextAuth configuration to enable Guilded as a provider.
• Explore a working OAuth flow in Remix: Clone the demo app and run it locally to see the authorization and callback endpoints in action.
• Read the API docs: Use authlink.app/dev/docs to understand client registration, authorization codes, and token responses.

How does Authlink run locally?

The repository is set up with standard npm scripts. Run npm install to install dependencies, npm run dev to start a development server that watches and reloads on change, and npm run build followed by npm start for production.

FAQ

Is Authlink open source?

Yes, Authlink is hosted on GitHub under the GuildedAPI organization, and the contributing guide requests that users create issues or contact the maintainers before making significant changes.

Does Authlink work with Next.js?

Yes, the project includes the next-auth-guilded package, which plugs Guilded into a NextAuth.js configuration for Next.js applications.

How do I run the demonstration app?

Clone the GuildedAPI/authlink-demo repository, run npm install, then start it with npm run dev and open the local URL to see the Guilded OAuth flow.