9863df3fb2
## Documentation / Examples - [x] Make sure the linting passes by running `pnpm lint` - [x] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md) This PR fixes the npm/pnpm/yarn commands to use with-xata instead of Contentful. |
||
---|---|---|
.. | ||
pages | ||
public | ||
styles | ||
utils | ||
.gitignore | ||
next-env.d.ts | ||
package.json | ||
README.md | ||
schema.template.json | ||
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
Demo
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 Your Xata Workspace and Run Codegen
💡 consider installing the Xata CLI globally, it will likely improve your experience managing your databases
npm run start:xata
⚠️ once linked, you can just run
xata
to re-generate types.
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()
orgetStaticProps()
- Create a Serverless Route(s) to handle data mutations
Deploy it to the cloud with Vercel (Documentation).