https://github.com/matthewmorek/authjs-adapter-orchidorm

https://github.com/matthewmorek/authjs-adapter-orchidorm

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/matthewmorek/authjs-adapter-orchidorm
• Owner: matthewmorek
• License: mit
• Created: 2024-03-03T22:10:06.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T01:36:24.000Z (3 months ago)
• Last Synced: 2024-11-28T21:52:58.448Z (25 days ago)
• Language: TypeScript
• Size: 222 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Auth.js OrchidORM Adapter

An adapter for Auth.js/NextAuth.js to allow you to connect to any database service via OrchidORM.

User table is required, optional tables are:

- **account**: for OAuth2 providers, stores provider info and token data;

- **session**: to store user session when choosing database strategy, not needed for `jwt` strategy;

- **verificationToken**: for [Email](https://next-auth.js.org/providers/email) provider.

See required table structures in this [migration](./demos/nextjs/src/db/migrations/0001_create-auth-tables.ts) file.

Table names can be changed, but column names should be as it is in the file above. Tables may have additional columns.

For proper typing of NextAuth functions, override NextAuth types in the [types/next-auth.d.ts](./demos/nextjs/types/next-auth.d.ts).

## NextJS demo

This repo contains demo NextJS project with GitHub and Email providers.

- Auth.js config is in [src/app/(auth)/auth.ts](./demos/nextjs/src/app/(auth)/auth.ts).

- database files (migrations, tables, configs) are in [src/db](./demos/nextjs/src/db).

To run it locally:

- pull the repo

- `cd demos/nextjs`

- `pnpm i`

- create GitHub App: click on your picture on GitHub -> Settings -> Developer settings -> New GitHub App

- `cp .env.example .env.local` and edit secrets

- run `pnpm db create` to create database with credentials from `.env.local`

- `pnpm db up` to run migrations

- `pnpm dev` to launch NextJS