Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 4.18 KB

README.md

File metadata and controls

78 lines (50 loc) · 4.18 KB
Raw

Group 1

React + Express Auth Starter Template

thirdweb SDK Discord

The template is a standard monorepo separated into a client and a server. The client is a React app using Vite and the server is an Express app. Both the server and client use TypeScript and Bun (can be substituted for npm, yarn, or pnpm).

The client uses thirdweb's Auth SDK to communicate with the server via your own routes. When a user is authenticated, the server returns a JWT which the client can cache for future requests. Thirdweb's Auth SDK takes care of the difficult pieces like payload generation and signing while allowing you to control how authentication happens between your backend and frontend.

Getting Started

Note, all commands can be substituted with npm, yarn, or pnpm if preferred.

First, install dependencies on both the client and server:

cd client && bun install
cd server && bun install

Environment variables

Copy the .env.example files to .env:

cp client/.env.example client/.env
cp server/.env.example server/.env

In each .env file, complete any necessary values. There are comments in each .env.example file explaining what each value does.

Running the app

Then, run the client and server in development mode:

cd client && bun run dev
cd server && bun run dev

Or from the root directory:

bun run client
bun run server

How it works

All authentication logic happens in just two files: one in the client, and one on the server.

On the client, ConnectButtonAuth.tsx uses the thirdweb ConnectButton to specify the auth object, which contains the callbacks to manage all auth requests your application makes. This same process can be done with your own custom components using the underlying functions in thirdweb/auth. The connect button is a template for the four functions every application's auth needs to implement:

  • isLoggedIn checks whether or not the current user is logged in, the criteria for this is up to you but the default uses a JWT in local cookie storage
  • getLoginPayload retrieves the message to sign for login from the server. The function to generate this payload is provided for you in the SDK, you simply need to send it to the server
  • doLogin attempts to log the user with a signed payload. Normally, this involves sending the payload to your Express server.
  • doLogout logs the user out. This function is entirely up to you and is based on how you handle authentication. In this app for example, it clears the local storage.

Note: All complex logic such as generating and signing payloads, caching and invalidating state, and more is handled for you by the SDK. Even if you're using your own components, thirdweb provides the underlying functions to execute these steps. Check out our documentation to learn more.

On the server, server.ts handles all routes for the app. The SDK provides a number of useful functions to keep your backend routes as simple as possible:

  • generatePayload generates a login payload for a given user address. This is the message the user's accont signs on the client and returns to the server for verification.
  • verifyPayload verifies the user's signed payload to either log them in, or reject the attempt.
  • generateJWT won't always be needed, but is a helpful function to generate a JWT for the user to use as in cookies or client-side storage to cache the user's session
  • verifyJWT checks if a given JWT is valid when authenticating requests.

Documentation

Support

For help or feedback, please visit our support site