rsnext/examples/with-postgres
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
lib docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
migrations docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
pages docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
public docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
styles docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
.env.local.example docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
ley.config.js docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
next.config.js Remove swcMinify option from example configs (#43012) 2022-11-16 13:39:26 -08:00
package.json docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tsconfig.json docs(examples): add postgres.js example (#42962) 2022-11-16 09:17:43 +01:00

Postgres.js Example

An example using Postgres.js in a Next.js project.

Deploy your own

Once you have access to the environment variables you'll need, deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-postgres with-postgres-app
yarn create next-app --example with-postgres with-postgres-app
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):

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:

npm run migrate:up
# or
yarn migrate:up

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.

Deploy on Vercel

Deploy it to the cloud with Vercel (Documentation).