Repository: planetscale/nextjs-planetscale-starter Branch: main Commit: 4216f41dbd0a Files: 38 Total size: 87.5 KB Directory structure: gitextract_rfzpuwrk/ ├── .gitignore ├── LICENSE ├── README.md ├── db/ │ ├── index.ts │ ├── schema.prisma │ └── seed.ts ├── lib/ │ ├── auth/ │ │ ├── WithAuth.tsx │ │ ├── passwords.ts │ │ ├── session.ts │ │ └── useAuth.ts │ ├── components/ │ │ ├── Layouts/ │ │ │ ├── AdminLayout.tsx │ │ │ └── AppLayout.tsx │ │ ├── Loader.tsx │ │ └── NavigationBar.tsx │ ├── styles/ │ │ └── index.css │ └── types.ts ├── netlify.toml ├── next-env.d.ts ├── next.config.js ├── package.json ├── pages/ │ ├── _app.tsx │ ├── admin/ │ │ ├── index.tsx │ │ ├── setup.tsx │ │ └── sign-in.tsx │ ├── api/ │ │ ├── auth/ │ │ │ ├── [...nextauth].ts │ │ │ └── administrator/ │ │ │ └── create.ts │ │ ├── users.ts │ │ └── with-session-example.ts │ ├── client-redirect.tsx │ ├── client.tsx │ ├── index.tsx │ ├── server-redirect.tsx │ ├── server.tsx │ ├── sign-in.tsx │ └── with-session.tsx ├── postcss.config.js ├── tailwind.config.js └── tsconfig.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitignore ================================================ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. # .env file .env # dependencies /node_modules /.pnp .pnp.js # testing /coverage # next.js /.next/ /out/ # production /build # misc .DS_Store *.pem # debug npm-debug.log* yarn-debug.log* yarn-error.log* # local env files .env.local .env.development.local .env.test.local .env.production.local .env.staging .env.production # vercel .vercel # Webstorm .idea .vscode # Local Netlify folder .netlify ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2021 PlanetScale, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # Next.js Starter App for Netlify ## Overview This README will guide you in getting up and running with Next.js starter app with authentication [NextAuth.js](https://next-auth.js.org/) and deployed on Netlify. Immediately, you can allow users to sign up or login to your app, including a built-in admin panel with a users table (powered by [PlanetScale](https://planetscale.com)). We have configured this template for you to one-click deploy directly to Netlify. Alternatively, you can manually deploy to your choice of hosting platform for Next.js applications. For more information on why we created this starter app, read me more in our [blog post](https://planetscale.com/blog/nextjs-netlify-planetscale-starter-app). [🖼 Live Demo](https://nextjs-planetscale-starter.netlify.app/) ![Example login screen](https://cdn.sanity.io/images/f1avhira/production/9767f106ce5d17f93054ba6ee8a930c546283348-2874x1586.png) ## 🥞 Stack - Framework - [Next.js v12](https://nextjs.org) - Language - [TypeScript](https://www.typescriptlang.org/) - Auth - [NextAuth.js](https://next-auth.js.org/) - Database - [PlanetScale](https://planetscale.com) - ORM - [Prisma](https://prisma.io) - Hosting - [Netlify](https://netlify.com) - Styling - [TailwindCSS](https://tailwindcss.com) ## Getting Started To follow along with this guide, you'll need the following: - A [free PlanetScale account](https://auth.planetscale.com/sign-up) - The [PlanetScale CLI](https://github.com/planetscale/cli#installation) - [Yarn](https://yarnpkg.com/getting-started/install) - [Node (LTS)](https://nodejs.org/en/) - A [free Netlify account](https://app.netlify.com/signup) ### One-click Deploy with Netlify (recommended) The one-click deploy button allows you to connect Netlify to your GitHub account to clone the nextjs-planetscale-starter repository and automatically deploy it. Be sure to sign up for a Netlify account before clicking the deploy button. [![Deploy to Netlify button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/planetscale/nextjs-planetscale-starter) Once you click the button, you'll be taken to Netlify’s direct deploy page with the pre-built project’s repository passed as a parameter in the URL. Click the "Connect to GitHub" button to authorize access. Next, you'll be asked to configure your site variables. For the Secret value, navigate to [https://generate-secret.now.sh/32](https://generate-secret.now.sh/32) to generate a secret and then paste that in. You can leave the Database URL and NextAuth URL values blank for now. Click "Save & Deploy". Your site will take about a minute to build and then you'll be taken to a settings page. A unique Netlify URL will be generated for the project. You can click that now to see your live site! **Important:** Once the site is deployed, [follow these steps](https://planetscale.com/docs/tutorials/nextjs-planetscale-netlify-template) to get your PlanetScale database up and running. > Note: If you do not follow the steps to get your database set up, you will see a 500 error on your live site. ## Admin accounts Admin accounts have access to `/admin`, which contains a user dashboard (powered by PlanetScale). This dashboard is a great starting place to build out an admin dashboard for your app. ![Example users table](https://cdn.sanity.io/images/f1avhira/production/e2f1b5c5d47887315b2fa17f4039ee9c638e798e-2876x1588.png) ## Caveats This application is close to production ready, but there are a few things you will need to consider and implement. #### What's not in this starter app? - **Email Sending & Password Resets:** We've left this implementation up to the user because we did not want to make adding an email provider a requirement. The default `VerificationToken` schema has the basics required for implementing sign up verification, or password reset requests. - **API Security:** Although NextAuth.js can be used for authentication, it does not provide authorization out of the box. The application comes with and example of protecting API routes using NextAuth.js. It does not cover things like making sure only administrators can access certain routes or making sure that only a user is able to update their account. - **Multiple admin accounts** ================================================ FILE: db/index.ts ================================================ import { PrismaClient } from "@prisma/client"; export * from "@prisma/client"; let prisma: PrismaClient; if (process.env.NODE_ENV === "production") { prisma = new PrismaClient({ errorFormat: "minimal", }); } else { globalThis["prisma"] = globalThis["prisma"] || new PrismaClient({ errorFormat: "pretty", }); prisma = globalThis["prisma"]; } export default prisma; ================================================ FILE: db/schema.prisma ================================================ // This is your Prisma schema file, // learn more about it in the docs: https://pris.ly/d/prisma-schema datasource db { provider = "mysql" url = env("DATABASE_URL") referentialIntegrity = "prisma" } generator client { provider = "prisma-client-js" previewFeatures = ["referentialIntegrity"] } model Account { id String @id @default(cuid()) createdAt DateTime @default(now()) updatedAt DateTime @updatedAt userId String type String provider String providerAccountId String refresh_token String? @db.VarChar(500) access_token String? @db.VarChar(500) refresh_token_expires_in Int? expires_at Int? token_type String? scope String? id_token String? @db.Text session_state String? oauth_token_secret String? oauth_token String? user User @relation(fields: [userId], references: [id], onDelete: Cascade) @@unique([provider, providerAccountId]) } model Session { id String @id @default(cuid()) sessionToken String @unique expires DateTime user User? @relation(fields: [userId], references: [id], onDelete: Cascade) userId String? } model User { id String @id @default(cuid()) createdAt DateTime @default(now()) updatedAt DateTime @updatedAt name String? email String? @unique password String? emailVerified DateTime? image String? role String? @default("user") accounts Account[] sessions Session[] } model VerificationToken { identifier String token String @unique expires DateTime @@unique([identifier, token]) } ================================================ FILE: db/seed.ts ================================================ import { PrismaClient } from "@prisma/client"; import { hash } from "bcryptjs"; const prisma = new PrismaClient(); async function main() { const encryptedPassword = await hash("password1234", 12); await prisma.user.upsert({ where: { email: "a@a.com" }, update: {}, create: { email: "a@a.com", name: "Alice", password: encryptedPassword, }, }); await prisma.user.upsert({ where: { email: "b@b.com" }, update: {}, create: { email: "b@b.com", name: "Bob", password: encryptedPassword, }, }); await prisma.user.upsert({ where: { email: "c@c.com" }, update: {}, create: { email: "c@c.com", name: "Carla", password: encryptedPassword, }, }); } main() .catch((e) => { console.error(e); process.exit(1); }) .finally(async () => { await prisma.$disconnect(); }); ================================================ FILE: lib/auth/WithAuth.tsx ================================================ import { useSession, signIn } from "next-auth/react"; import { useEffect } from "react"; import router from "next/router"; import Loader from "@lib/components/Loader"; function WithAuth({ children, options }) { const { data: session, status } = useSession(); const isUser = !!session?.user; useEffect(() => { // Do nothing while loading if (status === "loading") { return; } // If not authenticated, redirect to provided url or if (!isUser) { if (options?.redirectTo) { router.push(options.redirectTo); } else { signIn(); } } }, [isUser, status]); if (isUser) { return children; } // Session is being fetched, or no user. // If no user, useEffect() will redirect. return (
); } export default WithAuth; ================================================ FILE: lib/auth/passwords.ts ================================================ import { hash, compare } from 'bcryptjs'; export async function hashPassword(password) { const hashedPassword = await hash(password, 12); return hashedPassword; } export async function verifyPassword(password, hashedPassword) { const isValid = await compare(password, hashedPassword); return isValid; } ================================================ FILE: lib/auth/session.ts ================================================ import { DefaultSession } from "next-auth"; import { getSession as getNextSession, GetSessionParams, } from "next-auth/react"; type DefaultSessionUser = NonNullable; type SessionUser = DefaultSessionUser & { id: string; role: string; }; export type Session = DefaultSession & { user?: SessionUser; }; export async function getSession( options: GetSessionParams ): Promise { const session = await getNextSession(options); // that these are equal are ensured in `[...nextauth]`'s callback return session as Session | null; } ================================================ FILE: lib/auth/useAuth.ts ================================================ ================================================ FILE: lib/components/Layouts/AdminLayout.tsx ================================================ import { signOut } from "next-auth/react"; import { Fragment } from "react"; import { Menu, Transition } from "@headlessui/react"; import { UserIcon } from "@heroicons/react/outline"; import { ChevronDownIcon } from "@heroicons/react/solid"; import classNames from "classnames"; import Link from "next/link"; const navigation = [ { name: "Users", href: "#", current: true }, { name: "Help", href: "#", current: false }, ]; const AdminLayout = (props) => { return ( <>
{/* Profile dropdown */}
Open user menu for {/* {user.name ?? user.email} */}
{({ active }) => ( signOut()} className={classNames( active ? "bg-gray-100" : "", "block px-4 py-2 text-sm text-gray-700" )} > Logout )}
{navigation.map((item) => ( {item.name} ))}

{props.title}

{props.children}
); }; export default AdminLayout; ================================================ FILE: lib/components/Layouts/AppLayout.tsx ================================================ import classNames from "classnames"; import { useSession, signOut, signIn } from "next-auth/react"; import Link from "next/link"; import { Menu, Transition } from "@headlessui/react"; import { UserIcon } from "@heroicons/react/outline"; import { ChevronDownIcon } from "@heroicons/react/solid"; import { Fragment } from "react"; import { useRouter } from "next/router"; const AppLayout = (props) => { const { status, data: session } = useSession({ required: false, }); const router = useRouter(); const currentPath = router.pathname; const NAV_ITEMS = [ { title: "Home", href: "/", }, { title: "Client", href: "/client", }, { title: "Server", href: "/server", }, { title: "With Session", href: "/with-session", }, { title: "Client Redirect", href: "/client-redirect", }, { title: "Server Redirect", href: "/server-redirect", }, ]; return ( <>
{NAV_ITEMS.map((item) => ( {item.title} ))}

{props.title}

{props.children}
); }; export default AppLayout; ================================================ FILE: lib/components/Loader.tsx ================================================ import classNames from "classnames"; type LoaderProps = { className?: string; absoluteFill?: string; }; const Loader = ({ className, absoluteFill }: LoaderProps) => { return (
); }; export default Loader; ================================================ FILE: lib/components/NavigationBar.tsx ================================================ /* This example requires Tailwind CSS v2.0+ This example requires some changes to your config: ``` // tailwind.config.js module.exports = { // ... plugins: [ // ... require('@tailwindcss/forms'), ], } ``` */ import { Fragment } from "react"; import { Disclosure, Menu, Transition } from "@headlessui/react"; import { SearchIcon } from "@heroicons/react/solid"; import { BellIcon, MenuIcon, XIcon } from "@heroicons/react/outline"; function classNames(...classes) { return classes.filter(Boolean).join(" "); } export default function NavigationBar() { return ( {({ open }) => ( <>
Workflow
{/* Current: "border-indigo-500 text-gray-900", Default: "border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700" */} Dashboard Team Projects Calendar
{/* Mobile menu button */} Open main menu {open ? (
{/* Profile dropdown */}
Open user menu
{({ active }) => ( Your Profile )} {({ active }) => ( Settings )} {({ active }) => ( Sign out )}
{/* Current: "bg-indigo-50 border-indigo-500 text-indigo-700", Default: "border-transparent text-gray-600 hover:bg-gray-50 hover:border-gray-300 hover:text-gray-800" */} Dashboard Team Projects Calendar
Tom Cook
tom@example.com
Your Profile Settings Sign out
)}
); } ================================================ FILE: lib/styles/index.css ================================================ /* purgecss start ignore */ @tailwind base; @tailwind components; /* purgecss end ignore */ @tailwind utilities; /* body { font-family: -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji; } */ .button { @apply inline-flex px-2.5 py-1.5 text-xs text-center items-center justify-center border border-transparent font-medium shadow-sm text-white bg-black focus:outline-none focus:ring-1 focus:ring-offset-0 focus:ring-gray-800; @apply disabled:bg-opacity-80; @apply rounded-md; } .button__round { @apply rounded-full !important; } .button__secondary { @apply bg-white text-black; @apply border border-gray-400; } .button__third { @apply bg-black text-white; } .button__sm { @apply px-2.5 py-1.5 text-xs; } .button__md { @apply px-3 py-2 text-sm; } .button__lg { @apply px-4 py-2 text-sm; } .button__xl { @apply px-6 py-3 text-base; } blockquote { @apply bg-gray-200; @apply my-6 p-2; @apply overflow-auto break-words; } a { @apply text-blue-300; } ================================================ FILE: lib/types.ts ================================================ import { AppProps } from "next/app"; import { Component } from "react"; export type AuthenticatedPage = { role?: string; redirectTo?: string; // redirect to this url }; export type ExtendedPageProps = { requiresAuth?: boolean auth?: AuthenticatedPage; layout?: Component; }; export type ExtendedAppProps = AppProps & { Component: ExtendedPageProps; }; ================================================ FILE: netlify.toml ================================================ [build] command = "yarn db:generate && yarn build" publish = ".next" [[plugins]] package = "@netlify/plugin-nextjs" [template.environment] NEXTAUTH_SECRET = "Secret, use https://generate-secret.now.sh/32 to create one." DATABASE_URL = "Database URL, leave blank for now. See docs for more info." NEXTAUTH_URL = "NextAuth URL, leave blank for now. See docs for more info." ================================================ FILE: next-env.d.ts ================================================ /// /// /// // NOTE: This file should not be edited // see https://nextjs.org/docs/basic-features/typescript for more information. ================================================ FILE: next.config.js ================================================ if (!process.env.NEXTAUTH_URL) { console.warn( "\x1b[33mwarn", "\x1b[0m", "NEXTAUTH_URL environment variable is not set." ); if (process.env.URL) { process.env.NEXTAUTH_URL = process.env.URL; console.warn( "\x1b[33mwarn", "\x1b[0m", `NEXTAUTH_URL environment variable is not set. Using Netlify URL ${process.env.URL}.` ); } } module.exports = { target: "experimental-serverless-trace", future: { webpack5: true, }, typescript: { ignoreBuildErrors: true, }, }; ================================================ FILE: package.json ================================================ { "name": "starter", "version": "0.0.0", "private": true, "scripts": { "dev": "next", "build": "next build", "start": "next start", "db:generate": "prisma generate --schema=./db/schema.prisma", "db:migrate": "prisma migrate dev --schema=./db/schema.prisma --skip-seed", "db:reset": "prisma migrate reset --schema=./db/schema.prisma --skip-seed", "db:push": "prisma db push --schema=./db/schema.prisma --skip-seed", "db:seed": "npx prisma db seed", "db:studio": "prisma studio --schema=./db/schema.prisma", "now-build": "yarn generate --schema=./db/schema.prisma && next build" }, "dependencies": { "@headlessui/react": "^1.4.1", "@heroicons/react": "^1.0.5", "@next-auth/prisma-adapter": "^0.5.2-next.19", "@prisma/client": "^3.3.0", "@tailwindcss/forms": "^0.2.1", "bcryptjs": "^2.4.3", "classnames": "^2.3.1", "lodash": "^4.17.21", "next": "^12.0.5", "next-auth": "4.0.0-beta.6", "next-connect": "^0.10.2", "react": "^17.0.2", "react-dom": "^17.0.2", "react-hook-form": "^7.18.1", "react-query": "^3.23.2", "superagent": "^6.1.0" }, "prisma": { "seed": "ts-node --compiler-options {\"module\":\"CommonJS\"} db/seed.ts" }, "devDependencies": { "@netlify/plugin-nextjs": "^4.0.0-beta.4", "@types/bcryptjs": "^2.4.2", "@types/lodash": "^4.14.176", "@types/node": "^14.14.33", "@types/react": "^17.0.3", "@types/superagent": "^4.1.13", "@typescript-eslint/eslint-plugin": "^4.27.0", "@typescript-eslint/parser": "^4.27.0", "autoprefixer": "^10.2.5", "eslint": "^7.29.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-prettier": "^3.4.0", "eslint-plugin-react": "^7.24.0", "eslint-plugin-react-hooks": "^4.2.0", "jest": "^27.0.5", "lint-staged": "^11.0.0", "mockdate": "^3.0.5", "postcss": "^8.2.8", "prettier": "^2.3.1", "prisma": "^3.3.0", "tailwindcss": "^2.2.2", "ts-node": "^10.4.0", "typescript": "^4.2.3", "webpack": "^5.62.1" } } ================================================ FILE: pages/_app.tsx ================================================ import React from "react"; import type { ExtendedAppProps } from "@lib/types"; import { QueryClient, QueryClientProvider } from "react-query"; import { SessionProvider } from "next-auth/react"; import "@lib/styles/index.css"; import WithAuth from "@lib/auth/WithAuth"; export const queryClient = new QueryClient(); function MyApp({ Component, pageProps: { session, ...pageProps }, }: ExtendedAppProps) { return ( {Component.auth ? ( ) : ( )} ); } export default MyApp; ================================================ FILE: pages/admin/index.tsx ================================================ import { useQuery } from "react-query"; import { useSession } from "next-auth/react"; import { useRouter } from "next/router"; import { ChevronRightIcon } from "@heroicons/react/solid"; import { GetServerSidePropsContext } from "next"; import classNames from "classnames"; import AdminLayout from "@lib/components/Layouts/AdminLayout"; import { getSession } from "@lib/auth/session"; import superagent from "superagent"; const statusStyles = { true: "bg-green-100 text-green-800", false: "bg-gray-100 text-gray-800", }; function Page() { const router = useRouter(); const { status, data: { session }, } = useSession({ required: true, onUnauthenticated() { router.push("/", "/", {}); }, }); if (status === "loading") { return "Loading or not authenticated..."; } const usersQuery = useQuery(["users"], async () => { const data = await superagent.get("/api/users").send({ select: { id: true, name: true, email: true, image: true, emailVerified: true, accounts: { select: { type: true, provider: true, }, }, }, }); return data.body; }); if (usersQuery.isLoading) { return
loading...
; } return ( <> {/* {/* Activity list (smallest breakpoint only) */}
{/* Activity table (small breakpoint and up) */}
{usersQuery?.data && usersQuery.data.map((user) => { return ( ); })}
Email Name Status Providers
{user.name} {user.emailVerified ? "Verified" : "Not Verified"} {user?.accounts && user?.accounts?.length > 0 ? ( user.accounts.map((account) => { return

{account.provider}

; }) ) : (

credentials

)}
); } // Page.auth = true export default Page; export async function getServerSideProps(context: GetServerSidePropsContext) { const session = await getSession(context); if (!session || session?.user?.role !== "admin") { return { redirect: { permanent: false, destination: "/" } }; } return { props: { session: session }, }; } ================================================ FILE: pages/admin/setup.tsx ================================================ import { getCsrfToken, signIn } from "next-auth/react"; import { GetServerSidePropsContext } from "next"; import Head from "next/head"; import React from "react"; import { useForm } from "react-hook-form"; import superagent from "superagent"; import prisma from "@db"; const MINIMUM_ACTIVITY_TIMEOUT = 850; type LoginFormValues = { csrfToken: string; email: string; password: string; }; export default function Page({ csrfToken }) { const [isSubmitting, setSubmitting] = React.useState(false); const { register, handleSubmit } = useForm(); const createAdminAccountHandler = async (data: LoginFormValues) => { const response = await superagent .post("/api/auth/administrator/create") .send({ csrfToken: data.csrfToken, email: data.email, password: data.password, }); return response.body; }; const onSubmit = async (data: LoginFormValues) => { setSubmitting(true); try { createAdminAccountHandler(data) .then((response) => { signIn("admin-login", { callbackUrl: "/admin", email: data.email, password: data.password, }); }) .catch((error) => {}); setTimeout(() => { setSubmitting(false); }, MINIMUM_ACTIVITY_TIMEOUT); } catch (error) { console.error(error); // setError(error) setSubmitting(false); } }; return (
Setup
PlanetScale Logo

Welcome to the PlanetScale Next.js Starter App

Get started by creating an administrative account to setup.

); } export async function getServerSideProps(context: GetServerSidePropsContext) { const maybeAdministrator = await prisma.user.findFirst({ where: { role: "admin", }, }); if (maybeAdministrator) { return { redirect: { destination: "/", permanent: false, }, }; } return { props: { csrfToken: await getCsrfToken({ req: context.req }) }, }; } ================================================ FILE: pages/admin/sign-in.tsx ================================================ import { getCsrfToken, getSession, signIn } from "next-auth/react"; import { GetServerSidePropsContext } from "next"; import Head from "next/head"; import React from "react"; import { useForm } from "react-hook-form"; const MINIMUM_ACTIVITY_TIMEOUT = 850; type LoginFormValues = { csrfToken: string; email: string; password: string; }; export default function Page({ csrfToken }) { const [isSubmitting, setSubmitting] = React.useState(false); const { register, handleSubmit } = useForm(); const onSubmit = async (data: LoginFormValues) => { setSubmitting(true); try { signIn("admin-login", { callbackUrl: "/admin", redirect: true, email: data.email, password: data.password, }); setTimeout(() => { setSubmitting(false); }, MINIMUM_ACTIVITY_TIMEOUT); } catch (error) { console.error(error); // setError(error) setSubmitting(false); } }; return (
Admin Sign In
PlanetScale Logo

Admin Sign In

); } export async function getServerSideProps(context: GetServerSidePropsContext) { const session = await getSession(context); if (session) { return { redirect: { permanent: false, destination: "/" } }; } return { props: { csrfToken: await getCsrfToken({ req: context.req }) }, }; } ================================================ FILE: pages/api/auth/[...nextauth].ts ================================================ import NextAuth from "next-auth"; import CredentialsProvider from "next-auth/providers/credentials"; import GitHubProvider from "next-auth/providers/github"; import { PrismaAdapter } from "@next-auth/prisma-adapter"; import { verifyPassword, hashPassword } from "@lib/auth/passwords"; import { Session } from "@lib/auth/session"; import prisma from "@db/index"; export default NextAuth({ adapter: PrismaAdapter(prisma), secret: process.env.NEXTAUTH_SECRET, session: { jwt: true, }, pages: { signIn: "/sign-in", // signOut: "/auth/logout", // error: "/auth/error", // Error code passed in query string as ?error= }, providers: [ GitHubProvider({ clientId: process.env.GITHUB_CLIENT_ID, clientSecret: process.env.GITHUB_CLIENT_SECRET, }), CredentialsProvider({ id: "app-login", name: "App Login", credentials: { email: { label: "Email Address", type: "email", placeholder: "john.doe@example.com", }, password: { label: "Password", type: "password", placeholder: "Your super secure password", }, }, async authorize(credentials) { try { let maybeUser = await prisma.user.findFirst({ where: { email: credentials.email, }, select: { id: true, email: true, password: true, name: true, role: true, }, }); if (!maybeUser) { if (!credentials.password || !credentials.email) { throw new Error("Invalid Credentials"); } maybeUser = await prisma.user.create({ data: { email: credentials.email, password: await hashPassword(credentials.password), }, select: { id: true, email: true, password: true, name: true, role: true, }, }); } else { const isValid = await verifyPassword( credentials.password, maybeUser.password ); if (!isValid) { throw new Error("Invalid Credentials"); } } return { id: maybeUser.id, email: maybeUser.email, name: maybeUser.name, role: maybeUser.role, }; } catch (error) { console.log(error); throw error; } }, }), CredentialsProvider({ id: "admin-login", name: "Administrator Login", credentials: { email: { label: "Email Address", type: "email", placeholder: "john.doe@example.com", }, password: { label: "Password", type: "password", placeholder: "Your super secure password", }, }, async authorize(credentials) { let maybeUser = await prisma.user.findFirst({ where: { email: credentials.email, }, select: { id: true, email: true, password: true, name: true, role: true, }, }); if (!maybeUser) { throw new Error("Unauthorized."); } if (maybeUser?.role !== "admin") { throw new Error("Unauthorized."); } const isValid = await verifyPassword( credentials.password, maybeUser.password ); if (!isValid) { throw new Error("Invalid Credentials"); } return { id: maybeUser.id, email: maybeUser.email, name: maybeUser.name, role: maybeUser.role, }; }, }), ], callbacks: { async signIn({ user, account, profile, email, credentials }) { return true; }, async redirect({ url, baseUrl }) { return url.startsWith(baseUrl) ? url : baseUrl; }, async jwt({ token, user, account, profile, isNewUser }) { if (user) { token.id = user.id; token.role = user.role; } return token; }, async session({ session, token, user }) { const sess: Session = { ...session, user: { ...session.user, id: token.id as string, role: token.role as string, }, }; return sess; }, }, }); ================================================ FILE: pages/api/auth/administrator/create.ts ================================================ import { NextApiRequest, NextApiResponse } from "next"; import nc from "next-connect"; import { hashPassword } from "@lib/auth/passwords"; import prisma from "@db"; const post = async (req: NextApiRequest, res: NextApiResponse) => { try { const admin = await prisma.user.create({ data: { name: req.body.name, email: req.body.email, password: await hashPassword(req.body.password), role: "admin", }, select: { id: true, name: true, email: true, }, }); return res.status(200).json({ message: "Admin created.", data: admin, }); } catch (error) { console.error("[api] auth/administrator/create", error); return res.status(500).json({ statusCode: 500, message: error.message }); } }; export default nc().post(post); ================================================ FILE: pages/api/users.ts ================================================ import { NextApiRequest, NextApiResponse } from "next"; import isEmpty from "lodash/isEmpty"; import nc from "next-connect"; import prisma, { Prisma } from "@db"; import { getSession } from "@lib/auth/session"; const handler = async (req: NextApiRequest, res: NextApiResponse) => { const session = await getSession({ req }); if (!session) { return res.status(401).json({ message: "Unauthorized", }); } const selectInput = isEmpty(req.body?.select) ? undefined : req.body?.select; const whereInput = isEmpty(req.body?.where) ? undefined : req.body?.where; const includeInput = isEmpty(req.body?.include) ? undefined : req.body?.include; const orderByInput = isEmpty(req.body?.orderBy) ? undefined : req.body?.orderBy; const cursorInput = isEmpty(req.body?.cursor) ? undefined : req.body?.cursor; const takeInput = isEmpty(req.body?.take) ? undefined : req.body?.take; const skipInput = isEmpty(req.body?.skip) ? undefined : req.body?.skip; const distinctInput = isEmpty(req.body?.distinct) ? undefined : req.body?.distinct; const findManyArgs: Prisma.UserFindManyArgs = { select: selectInput, where: whereInput, include: includeInput, orderBy: orderByInput, cursor: cursorInput, take: takeInput, skip: skipInput, distinct: distinctInput, }; try { const users = await prisma.user.findMany(findManyArgs); return res.status(200).json(users); } catch (error) { console.error("[api] user", error); return res.status(500).json({ statusCode: 500, message: error.message }); } }; export default nc().get(handler); ================================================ FILE: pages/api/with-session-example.ts ================================================ import { getSession } from "@lib/auth/session"; export default async (req, res) => { const session = await getSession({ req }); if (session) { res.send({ content: "This is protected content. You can access this content because you are signed in.", }); } else { res.send({ error: "You must be sign in to view the protected content on this page.", }); } }; ================================================ FILE: pages/client-redirect.tsx ================================================ import AppLayout from "@lib/components/Layouts/AppLayout"; import { useSession } from "next-auth/react"; import { useRouter } from "next/router"; const Page = () => { const router = useRouter(); const { status, data: session } = useSession({ required: true, onUnauthenticated() { router.push("/", "/", {}); }, }); if (status === "loading") { return "Loading or not authenticated..."; } return ( <>

Hello, {`${session.user.name ?? session.user.email}`} This is a protected route. You can see it because you're logged in.

Client Side Rendering This page uses the useSession() React Hook. The useSession() React Hook is easy to use and allows pages to render very quickly. The advantage of this approach is that session state is shared between pages by using the Provider in _app.js so that navigation between pages using useSession() is very fast. The disadvantage of useSession() is that it requires client side JavaScript.

This page is protected using the useSession hook.

Either way works.

But in this case the session is not available on the first render.

); }; export default Page; ================================================ FILE: pages/client.tsx ================================================ import AppLayout from "@lib/components/Layouts/AppLayout"; import { useSession } from "next-auth/react"; import Loader from "@lib/components/Loader"; const Page = () => { const { status } = useSession({ required: false, }); if (status === "loading") { return ; } return ( <>

This page uses the useSession() React Hook.

The useSession() React Hook is easy to use and allows pages to render very quickly.

The advantage of this approach is that session state is shared between pages by using the Provider in _app.js so that navigation between pages using useSession() is very fast.

The disadvantage of useSession() is that it requires client side JavaScript.

This page is protected using the useSession hook.

Either way works.

But in this case the session is not available on the first render.

); }; export default Page; ================================================ FILE: pages/index.tsx ================================================ import AppLayout from "@lib/components/Layouts/AppLayout"; import Image from 'next/image'; const Page = () => { return ( <> {/*
*/}

Welcome to the PlanetScale Next.js Starter App!

This is an example site to demonstrate how to use{" "} NextAuth.js for authentication with PlanetScale and Prisma.

You can find how to get started{" "} here.

); }; export default Page; ================================================ FILE: pages/server-redirect.tsx ================================================ import AppLayout from "@lib/components/Layouts/AppLayout"; import { useSession } from "next-auth/react"; const Page = () => { const { data: session } = useSession(); return ( <>

Hello, {`${session.user.name ?? session.user.email}`} This is a protected route. You can see it because you're logged in.

This page is protected using Page.auth = true

Either way works.

But in this case the session is available on the first render.

); }; Page.auth = { redirectTo: "/", }; export default Page; ================================================ FILE: pages/server.tsx ================================================ import AppLayout from "@lib/components/Layouts/AppLayout"; import { useSession } from "next-auth/react"; import { getSession } from "@lib/auth/session"; const Page = () => { const { status, data: session } = useSession({ required: false, }); console.log(status, session); return ( <>

This page uses the universal getSession() method in getServerSideProps().

Using getSession() in getServerSideProps() is the recommended approach if you need to support Server Side Rendering with authentication.

The advantage of Server Side Rendering is this page does not require client side JavaScript.

The disadvantage of Server Side Rendering is that this page is slower to render.

This page is protected using the useSession hook.

Either way works.

But in this case the session is not available on the first render.

); }; export async function getServerSideProps(context) { return { props: { session: await getSession(context), }, }; } export default Page; ================================================ FILE: pages/sign-in.tsx ================================================ import { filter } from "lodash"; import { GetServerSidePropsContext } from "next"; import { getSession, getCsrfToken, signIn, getProviders, } from "next-auth/react"; import Head from "next/head"; import React from "react"; import { useForm } from "react-hook-form"; const MINIMUM_ACTIVITY_TIMEOUT = 850; type LoginFormValues = { csrfToken: string; email: string; password: string; }; export default function Page({ csrfToken, providers }) { const [isSubmitting, setSubmitting] = React.useState(false); const { register, handleSubmit } = useForm(); const handleProviderSignIn = (provider) => { signIn(provider.id); }; const onSubmit = async (data: LoginFormValues) => { setSubmitting(true); try { signIn("app-login", { callbackUrl: "/", email: data.email, password: data.password, }); setTimeout(() => { setSubmitting(false); }, MINIMUM_ACTIVITY_TIMEOUT); } catch (error) { console.error(error); // setError(error) setSubmitting(false); } }; return (
Sign In

Sign In

Sign in with an existing account, or create new account.


Or with
{providers.map((provider) => { return ( ); })}
); } export async function getServerSideProps(context: GetServerSidePropsContext) { const session = await getSession(context); if (session) { return { redirect: { permanent: false, destination: "/" } }; } const csrfToken = await getCsrfToken({ req: context.req }); const providers = filter(await getProviders(), (provider) => { return provider.type !== "credentials"; }); return { props: { csrfToken, providers }, }; } ================================================ FILE: pages/with-session.tsx ================================================ import AppLayout from "@lib/components/Layouts/AppLayout"; import { useSession, signIn } from "next-auth/react"; import { useQuery } from "react-query"; import superagent from "superagent"; const Page = () => { const { status, data: session } = useSession({ required: false, }); const withSessionQuery = useQuery( ["with-session-example", session], async () => { console.log(session); const data = await superagent.get("/api/with-session-example"); return data.body.content; }, { // The query will not execute until the session exists enabled: !!session, } ); if (status === "loading") { return "Loading or not authenticated..."; } console.log(withSessionQuery); if (!session) { return ( <>

Access Denied

to see a secret message

); } return ( <>

Hello, {`${session.user.name ?? session.user.email}`} You can see this because you're logged in.

This example shows usage with React Query and protected api routes.

{withSessionQuery?.data &&

{withSessionQuery.data}

}
); }; export default Page; ================================================ FILE: postcss.config.js ================================================ module.exports = { plugins: { tailwindcss: {}, autoprefixer: {}, }, } ================================================ FILE: tailwind.config.js ================================================ module.exports = { mode: "jit", purge: [ "./pages/**/*.{js,ts,jsx,tsx}", "./lib/components/**/*.{js,ts,jsx,tsx}", ], darkMode: "class", theme: { extend: {}, }, variants: { extend: {}, }, plugins: [require("@tailwindcss/forms")], }; ================================================ FILE: tsconfig.json ================================================ { "compilerOptions": { "target": "es5", "lib": ["dom", "dom.iterable", "esnext"], "baseUrl": ".", "paths": { "@api/*": ["pages/api/*"], "@lib/*": ["lib/*"], "@components/*": ["lib/components/*"], "@components": ["lib/components/index"], "@db/*": ["db/*"], "@db": ["db/index"] }, "allowJs": true, "skipLibCheck": true, "strict": false, "forceConsistentCasingInFileNames": true, "noEmit": true, "esModuleInterop": true, "module": "esnext", "moduleResolution": "node", "resolveJsonModule": true, "isolatedModules": true, "jsx": "preserve", "incremental": true }, "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"], "exclude": ["node_modules"] }