Unverified Commit 10b635ea authored by Silvio Clécio's avatar Silvio Clécio Committed by GitHub

docs(examples): add postgres.js example (#42962)

parent 5e11f527
DATABASE_URL=postgresql://user:pass@host/user/database?ssl=false
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# 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*
.pnpm-debug.log*
# local env files
.env*.local
# vercel
.vercel
# typescript
*.tsbuildinfo
next-env.d.ts
# Postgres.js Example
An example using [Postgres.js](https://github.com/porsager/postgres) in a Next.js project.
## Deploy your own
Once you have access to [the environment variables you'll need](#configure-environment-variables), deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-postgres&project-name=with-postgres&repository-name=with-postgres&env=DATABASE_URL&envDescription=Required%20to%20connect%20the%20app%20with%20Postgres)
## How to use
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
```bash
npx create-next-app --example with-postgres with-postgres-app
```
```bash
yarn create next-app --example with-postgres with-postgres-app
```
```bash
pnpm create next-app --example with-postgres with-postgres-app
```
## Configuration
### Set up a Postgres database
Set up a Postgres database locally or use your favorite provider.
### Configure environment variables
Copy the `.env.local.example` file in this directory to `.env.local` (this will be ignored by Git):
```bash
cp .env.local.example .env.local
```
Set the `DATABASE_URL` variable in `.env.local` to the connection uri of your postgres database.
### Apply migrations
To setup up the migrations, use:
```bash
npm run migrate:up
# or
yarn migrate:up
```
### Start Next.js in development mode
```bash
npm run dev
# or
yarn dev
```
Your app should now be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions).
## Deploy on Vercel
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
const dotenv = require('dotenv')
const { parse } = require('pg-connection-string')
dotenv.config({ path: '.env.local' })
const options = parse(process.env.DATABASE_URL || '')
module.exports = options
import postgres from 'postgres'
const sql = postgres(process.env.DATABASE_URL as string)
export default sql
import sql from './db'
export interface ToDo {
id: number
text: string
done: boolean
}
export async function list() {
return await sql<ToDo[]>`
SELECT id, text, done FROM todos
ORDER BY id
`
}
export async function create(todo: ToDo) {
return await sql<ToDo[]>`
INSERT INTO todos (text, done) VALUES (${todo.text}, false)
RETURNING id, text, done
`
}
export async function update(todo: ToDo) {
return await sql<ToDo[]>`
UPDATE todos SET done=${todo.done} WHERE id=${todo.id}
RETURNING id, text, done
`
}
export async function remove(todo: ToDo) {
return await sql<ToDo[]>`
DELETE FROM todos WHERE id=${todo.id}
RETURNING id, text, done
`
}
exports.up = async function (sql) {
await sql`
CREATE TABLE IF NOT EXISTS todos (
id SERIAL PRIMARY KEY NOT NULL,
text CHARACTER VARYING(255) NOT NULL,
done BOOLEAN NOT NULL DEFAULT FALSE
)
`
}
exports.down = async function (sql) {
await sql`
DROP TABLE IF EXISTS todos
`
}
/** @type {import('next').NextConfig} */
const nextConfig = {
reactStrictMode: true,
swcMinify: true,
}
module.exports = nextConfig
{
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"migrate:up": "ley up",
"migrate:down": "ley down"
},
"dependencies": {
"@types/node": "^18.11.9",
"@types/react": "^18.0.25",
"@types/react-dom": "^18.0.9",
"next": "latest",
"postgres": "^3.3.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"typescript": "^4.8.4"
},
"devDependencies": {
"dotenv": "^16.0.3",
"ley": "^0.8.1",
"pg-connection-string": "^2.5.0"
}
}
import type { AppProps } from 'next/app'
import '../styles/globals.css'
export default function App({ Component, pageProps }: AppProps) {
return <Component {...pageProps} />
}
import type { NextApiRequest, NextApiResponse } from 'next'
import { type ToDo } from '../../lib/todos'
import * as todos from '../../lib/todos'
export default async function handler(
req: NextApiRequest,
res: NextApiResponse<ToDo[] | string>
) {
switch (req.method) {
case 'GET':
return res.status(200).json(await todos.list())
case 'POST':
return res.status(201).json(await todos.create(req.body))
case 'PUT':
const updated = await todos.update(req.body)
return res.status(updated.length > 0 ? 200 : 404).json(updated)
case 'DELETE':
const removed = await todos.remove(req.body)
return res.status(removed.length > 0 ? 204 : 404).end()
default:
return res.status(405).send('Method Not Allowed')
}
}
import { useState, useEffect } from 'react'
import Head from 'next/head'
import { type ToDo } from '../lib/todos'
import styles from '../styles/Home.module.css'
interface ToDoComponentProps {
key: number
text: string
done: boolean
onChange: () => void
onRemove: () => void
}
const ToDoComponent = ({
text,
done,
onChange,
onRemove,
}: ToDoComponentProps) => {
const cards = ['card', 'card2', 'card3', 'card4', 'card5']
return (
<div className={styles[cards[Math.floor(Math.random() * cards.length)]]}>
<div
className={styles.text}
style={{ textDecoration: done ? 'line-through' : '' }}
>
{text}
</div>
<div className={styles.reverseWrapper}>
<input
type="checkbox"
className={styles.check}
checked={done}
onChange={onChange}
/>
<button className={styles.removeBtn} onClick={onRemove}>
&#10005;
</button>
</div>
</div>
)
}
export default function Home() {
const [newText, setNewText] = useState('')
const [toDos, setToDos] = useState<ToDo[]>([])
const getToDos = async () => {
const resp = await fetch('api/todos')
const toDos = await resp.json()
setToDos(toDos)
}
const createToDo = async () => {
await fetch('api/todos', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ text: newText }),
})
setNewText('')
await getToDos()
}
const updateToDo = async (todo: ToDo) => {
const newBody = {
id: todo.id,
done: !todo.done,
}
await fetch('api/todos', {
method: 'PUT',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(newBody),
})
await getToDos()
}
const removeToDo = async (todo: ToDo) => {
const newBody = {
id: todo.id,
}
await fetch('api/todos', {
method: 'DELETE',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(newBody),
})
await getToDos()
}
useEffect(() => {
getToDos()
}, [])
const done = toDos.filter((todo) => todo.done)
const undone = toDos.filter((todo) => !todo.done)
return (
<div className={styles.container}>
<Head>
<title>postgres.js + next.js</title>
<link rel="icon" href="/favicon.ico" />
</Head>
<header className={styles.header}>
<h2>
<a href="https://github.com/porsager/postgres">postgres.js</a> +{' '}
<a href="https://nextjs.org">next.js</a> to dos
</h2>
</header>
<main className={styles.main}>
<div className={styles.undone}>
<div className={styles.firstRow}>
<div className={styles.title}>to dos</div>
<div className={styles.reverseWrapper}>
<input
className={styles.input}
value={newText}
onChange={(e) => setNewText(e.target.value)}
onKeyDown={(e) => e.code === 'Enter' && createToDo()}
></input>
<button className={styles.createBtn} onClick={createToDo}>
&#10011;
</button>
</div>
</div>
<div className={styles.scrollable}>
{undone.map((todo, index) => (
<ToDoComponent
key={todo.id}
text={`${index + 1}. ${todo.text}`}
done={todo.done}
onChange={() => updateToDo(todo)}
onRemove={() => removeToDo(todo)}
/>
))}
</div>
</div>
<div className={styles.done}>
<div className={styles.firstRow}>
<div className={styles.title}>done</div>
</div>
<div className={styles.scrollable}>
{done.map((todo, index) => (
<ToDoComponent
key={todo.id}
text={`${index + 1}. ${todo.text}`}
done={todo.done}
onChange={() => updateToDo(todo)}
onRemove={() => removeToDo(todo)}
/>
))}
</div>
</div>
</main>
<footer className={styles.footer}>
<a
href="https://github.com/vercel/next.js/tree/canary/examples/with-postgres"
target="_blank"
rel="noopener noreferrer"
>
powered by postgres.js & next.js
</a>
</footer>
</div>
)
}
<svg width="283" height="64" viewBox="0 0 283 64" fill="none"
xmlns="http://www.w3.org/2000/svg">
<path d="M141.04 16c-11.04 0-19 7.2-19 18s8.96 18 20 18c6.67 0 12.55-2.64 16.19-7.09l-7.65-4.42c-2.02 2.21-5.09 3.5-8.54 3.5-4.79 0-8.86-2.5-10.37-6.5h28.02c.22-1.12.35-2.28.35-3.5 0-10.79-7.96-17.99-19-17.99zm-9.46 14.5c1.25-3.99 4.67-6.5 9.45-6.5 4.79 0 8.21 2.51 9.45 6.5h-18.9zM248.72 16c-11.04 0-19 7.2-19 18s8.96 18 20 18c6.67 0 12.55-2.64 16.19-7.09l-7.65-4.42c-2.02 2.21-5.09 3.5-8.54 3.5-4.79 0-8.86-2.5-10.37-6.5h28.02c.22-1.12.35-2.28.35-3.5 0-10.79-7.96-17.99-19-17.99zm-9.45 14.5c1.25-3.99 4.67-6.5 9.45-6.5 4.79 0 8.21 2.51 9.45 6.5h-18.9zM200.24 34c0 6 3.92 10 10 10 4.12 0 7.21-1.87 8.8-4.92l7.68 4.43c-3.18 5.3-9.14 8.49-16.48 8.49-11.05 0-19-7.2-19-18s7.96-18 19-18c7.34 0 13.29 3.19 16.48 8.49l-7.68 4.43c-1.59-3.05-4.68-4.92-8.8-4.92-6.07 0-10 4-10 10zm82.48-29v46h-9V5h9zM36.95 0L73.9 64H0L36.95 0zm92.38 5l-27.71 48L73.91 5H84.3l17.32 30 17.32-30h10.39zm58.91 12v9.69c-1-.29-2.06-.49-3.2-.49-5.81 0-10 4-10 10V51h-9V17h9v9.2c0-5.08 5.91-9.2 13.2-9.2z" fill="#000"/>
</svg>
\ No newline at end of file
.container {
padding: 0 0.5rem;
display: flex;
flex-direction: column;
justify-content: center;
align-items: center;
}
.main {
padding: 1rem 0;
width: 100%;
flex: 1;
display: flex;
flex-direction: row;
justify-content: center;
}
.done,
.undone {
display: flex;
flex-direction: column;
padding-left: 1.5rem;
padding-right: 1.5rem;
width: 50%;
}
.scrollable {
display: flex;
flex-direction: column;
height: calc(100vh - 170px);
overflow: scroll;
}
.firstRow {
display: flex;
align-items: center;
height: 52px;
}
.reverseWrapper {
display: flex;
margin-left: auto;
height: 100%;
align-items: center;
}
.header {
width: 100%;
height: 50px;
border-bottom: 1px solid #f1f1f1;
display: flex;
justify-content: flex-start;
align-items: center;
}
.header h2 {
padding-left: 24px;
}
.input {
border: 1px solid #c5c4c7;
border-radius: 2px;
padding-left: 5px;
padding-right: 5px;
font-size: 16px;
height: 32px;
margin-left: 10px;
margin-right: 10px;
width: 100%;
}
.input:focus,
.input:active {
border: 1px solid #2b66ff;
}
.createBtn,
.removeBtn {
display: flex;
align-items: center;
justify-content: center;
font-size: 32px;
background-color: transparent;
border: 1px solid transparent;
color: #c5c4c7;
border-radius: 2px;
height: 32px;
width: 32px;
}
.createBtn:hover,
.createBtn:focus,
.createBtn:active {
color: #1cec73;
}
.removeBtn:hover,
.removeBtn:focus,
.removeBtn:active {
color: #ee6262;
}
.check {
background-color: transparent;
border: 1px solid #c5c4c7;
border-radius: 2px;
height: 20px;
width: 20px;
margin-right: 10px;
}
.footer {
position: fixed;
bottom: 0;
width: 100%;
height: 50px;
border-top: 1px solid #f1f1f1;
display: flex;
justify-content: center;
align-items: center;
}
.footer a {
display: flex;
justify-content: center;
align-items: center;
}
.title a {
color: #2b66ff;
text-decoration: none;
}
.title a:hover,
.title a:focus,
.title a:active {
text-decoration: underline;
}
.title {
margin: 0;
line-height: 1.15;
font-size: 2rem;
padding-top: 10px;
padding-bottom: 10px;
text-align: start;
white-space: nowrap;
}
.card,
.card2,
.card3,
.card4,
.card5 {
display: flex;
color: #c5c4c7;
font-size: 18px;
font-weight: bold;
margin-top: 1rem !important;
margin-bottom: 1rem;
height: 50px;
align-items: center;
text-align: left;
text-decoration: none;
}
.card:hover,
.card:focus,
.card:active {
color: #0070f3;
}
.card2:hover,
.card2:focus,
.card2:active {
color: #ae00f3;
}
.card3:hover,
.card3:focus,
.card3:active {
color: #f3003d;
}
.card4:hover,
.card4:focus,
.card4:active {
color: #f39200;
}
.card4:hover,
.card4:focus,
.card4:active {
color: #29f300;
}
.card5:hover,
.card5:focus,
.card5:active {
color: #00f3cb;
}
.card,
.card2,
.card3,
.card4,
.card5 h3 {
margin: 0 0 1rem 0;
font-size: 1.5rem;
}
.text {
display: flex;
align-items: center;
text-transform: lowercase;
margin: 0;
font-size: 1.5rem;
line-height: 1.5;
}
@media (max-width: 600px) {
.main {
width: 100%;
flex-direction: column;
}
.header {
height: 70px;
}
.title {
flex: none;
}
.done,
.undone {
width: 100%;
}
.footer {
position: relative;
}
}
@media (prefers-color-scheme: dark) {
.header {
border-bottom: 1px solid rgb(120, 120, 120);
}
.card,
.footer {
border-color: rgb(90, 90, 90);
}
}
@import url(https://fonts.googleapis.com/css2?family=Source+Code+Pro&display=swap);
html,
body {
padding: 0;
margin: 0;
font-family: 'Source Code Pro', Courier New, monospace;
}
a {
color: #0070f3;
text-decoration: none;
}
input,
button {
font-family: 'Source Code Pro', Arial, sans-serif;
}
a:hover,
a:focus,
a:active {
text-decoration: underline;
}
* {
box-sizing: border-box;
}
@media (prefers-color-scheme: dark) {
html {
color-scheme: dark;
}
body {
color: rgb(200, 200, 200);
background: rgb(30, 30, 30);
}
}
{
"compilerOptions": {
"target": "es5",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"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"]
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment