rsnext/examples/with-xata
Steven 4466ba436b
chore(examples): use default prettier for examples/templates (#60530)
## Description
This PR ensures that the default prettier config is used for examples
and templates.

This config is compatible with `prettier@3` as well (upgrading prettier
is bigger change that can be a future PR).

## Changes
- Updated `.prettierrc.json` in root with `"trailingComma": "es5"` (will
be needed upgrading to prettier@3)
- Added `examples/.prettierrc.json` with default config (this will
change every example)
- Added `packages/create-next-app/templates/.prettierrc.json` with
default config (this will change every template)

## Related

- Fixes #54402
- Closes #54409
2024-01-11 16:01:44 -07:00
..
pages chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
public
styles chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
utils chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
.gitignore
next-env.d.ts
package.json update @types/react version in examples (#57259) 2023-10-26 19:52:08 -05:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
schema.template.json Fix deploy button in with-xata example (#43608) 2022-12-01 11:34:23 -08:00
tsconfig.json

Next.js + Xata

This example showcases how to use Next.js with Xata as your data layer.

With this template you get out-of-the-box:

  • API Route to connect to your Xata database
  • Type-safe Codegen
  • Accessibility-Ready
    • Dark/Light mode
    • Respects prefers-reduce-motion for CSS Transitions

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

Demo

nextjs-with-xata.vercel.app

How to use

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

npx create-next-app --example with-xata with-xata-app
yarn create next-app --example with-xata with-xata-app
pnpm create next-app --example with-xata with-xata-app

💡 We recommend installing the Xata CLI globally, but you can also use npx @xata.io/cli instead of xata in the commands below.

You can link your project with a Xata workspace by running the following command:

xata init

To update your types, run the following command:

xata codegen

Start Coding

Open http://localhost:3000 to view it in the browser.

💡 the template will prompt you to create a dummy new table (nextjs_with_xata_example) with some useful resources.

Notes

Some tips that may help you develop your app.

  • The Xata VS Code Extension will make managing your data more comfortable
  • Prefer fetching data from getServerSideProps() or getStaticProps()
  • Create a Serverless Route(s) to handle data mutations

Deploy it to the cloud with Vercel (Documentation).