Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wangel13/prisma-next-auth-graphql-starter
Next.js boilerplate for passwordless authentication with Prisma and next-auth with apollo graphql api with style from tailwindcss
https://github.com/wangel13/prisma-next-auth-graphql-starter
Last synced: 30 days ago
JSON representation
Next.js boilerplate for passwordless authentication with Prisma and next-auth with apollo graphql api with style from tailwindcss
- Host: GitHub
- URL: https://github.com/wangel13/prisma-next-auth-graphql-starter
- Owner: wangel13
- License: mit
- Created: 2020-09-29T15:30:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T00:06:22.000Z (about 1 year ago)
- Last Synced: 2024-08-03T00:10:08.891Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 109 KB
- Stars: 77
- Watchers: 3
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-prisma - prisma-next-auth-graphql-starter - Fullstack starter with Prisma, next-auth, next.js, tailwindcss and graphql-shield (:space_invader: Projects Using Prisma / Tutorials with [NestJS](https://nestjs.com/))
README
Fullstack starter with next-auth, prisma, next.js and graphql-shield
[](https://github.com/microsoft/TypeScript)
[](https://github.com/prettier/prettier)
[](https://github.com/eslint/eslint)
## 🚀 Getting started
1. **Setup a database.**
Use the predefined `docker-compose.yml` configuration for local `postgres` instance.
```shell
docker-compose up -d
```
don't forget about [`.env`](#-env)
Also, you can use any DB supported by Prisma([docs](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/data-sources/))
1. **Start developing.**
Navigate into your new site’s directory install modules and start it up.
```shell
npm i
npm run dev
```
1. **Open the source code and start editing!**
Your site is now running at [localhost:3000](http://localhost:3000)!
Open the `starter` directory in your code editor of choice and edit `src/pages/index.tsx`. Save your changes, and the browser will update in real-time!
## 🗃️ Database
### Database toolkit
Starter use [Prisma](https://www.prisma.io/docs/) for db queries.
### Migrations
1. **Modify your schema file.**
Open the `starter` directory in your code editor of choice and edit `prisma/schema.prisma`. Add Book model for example.
```prisma
model Book {
id String @id @default(cuid())
title String
authors User[] @relation(references: [id])
published Boolean @default(false)
content String
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
```
1. **Generate migration files.**
Use Prisma migrate tool.
```shell
prisma migrate dev --create-only --name init
```
You can find migration files in `prisma/migrations`.
1. **Apply migration.**
Use Prisma migrate tool.
```shell
prisma migrate dev
```
1. **Generate new fresh Prisma client.**
```shell
npm run generate
```
More info about Prisma Migrate you can find in [docs](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-migrate)
## 🧐 Auth
- Starter use [next-auth](https://github.com/nextauthjs/next-auth) - it's a complete open source authentication solution for Next.js applications.
- For graphql queries protection and auth rules you can use [graphql-shield](https://github.com/maticzav/graphql-shield). Starter has a basic setup for it.
## ⚒️ Bundled instruments
### Prisma studio
Prisma Studio is a visual editor for your database.
Open [prisma studio](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-studio) interface:
```
npm run studio
```
### Graphql playground
Starter use ApolloServer and it's provide [graphql-playground](https://github.com/graphql/graphql-playground) in `dev` mode.
You can find it on [localhost:3000/api/graphql](http://localhost:3000/api/graphql)
### Apollo Client Devtools
Starter use Apollo Client and it's provide [apollo-client-devtools](https://github.com/apollographql/apollo-client-devtools) in `dev` mode.
To use it you need to install browser extension:
[Download for Firefox](https://addons.mozilla.org/firefox/addon/apollo-developer-tools/) | [Download for Chrome](https://chrome.google.com/webstore/detail/apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm)
## 📜 ENV
Use `.env.local` on production or `.env.development` on dev. [Read more](https://nextjs.org/docs/basic-features/environment-variables)
```
# Database
DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/prisma?schema=public"
# Auth providers
AUTH_SECRET="this-is-a-secret-value-with-at-least-32-characters"
NEXTAUTH_URL="http://localhost:3000"
PROVIDER_GITHUB_ID=""
PROVIDER_GITHUB_SECRET=""
PROVIDER_SMTP_HOST=""
PROVIDER_SMTP_PORT=""
PROVIDER_SMTP_USER=""
PROVIDER_SMTP_PASSWORD=""
PROVIDER_SMTP_FROM=""
```
## 💫 Deploy
Before deploy, you need to set up a database.
[](https://vercel.com/import/project?template=https://github.com/wangel13/prisma-next-auth-graphql-starter)