4271c095fb
## What AMP is not supported with Turbopack. The knex example uses `@next/env` so it needs to be installed. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Closes NEXT-2989 |
||
---|---|---|
.. | ||
knex | ||
pages | ||
public | ||
.env.local.example | ||
.gitignore | ||
knexfile.js | ||
package.json | ||
README.md |
Example app using Knex
Knex is a SQL query builder that works with a variety of SQL databases including Postgres and MySQL. This example shows you how to use Knex with Next.js to connect and query a Postgres database. The same code can also connect to all other databases supported by Knex.
Deploy your own
Once you have access to the environment variables you'll need, deploy the example using Vercel:
How to use
Execute create-next-app
with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-knex with-knex-app
yarn create next-app --example with-knex with-knex-app
pnpm create next-app --example with-knex with-knex-app
Configuration
Install dependencies
npm install
# or
yarn
Set up a Postgres database
Set up a Postgres database locally or use a DBaaS provider such as AWS or Digital Ocean
Configure environment variables
Copy the .env.local.example
file in this directory to .env.local
(this will be ignored by Git):
cp .env.local.example .env.local
Set the PG_URI
variable in .env.local
to the connection uri of your postgres database.
Apply migrations
You can create, apply and rollback migrations using the scripts in package.json
. For now we will run the example migrations in the knex/migrations
folder, which will add some Todos to the database.
npm run migrate:latest
# or
yarn migrate:latest
Start Next.js in development mode
npm run dev
# or
yarn dev
Your app should now be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.
You should now see a list of Todos that were fetched from the database via the API Route defined in /pages/api/todos.js
.
Deploy on Vercel
You can deploy this app to the cloud with Vercel (Documentation).
Deploy Your Local Project
To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.
Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local
file.
Deploy from Our Template
Alternatively, you can deploy using our template by clicking on the Deploy button below.