README.md

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

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

Link With Your Xata Workspace And Update Types

💡 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).