remix-starter

Prisma Accelerate Example: Remix Starter

This project showcases how to use Prisma ORM with Prisma Accelerate in a Remix application. It demonstrates every available caching strategy in Accelerate.

Prerequisites

To successfully run the project, you will need the following:

• The connection string of a publicly accessible database.
• Your Accelerate connection string (containing your Accelerate API key) which you can get by enabling Accelerate in a project in your Prisma Data Platform account (learn more in the docs).

Getting started

1. Clone the repository

Clone the repository, navigate into it and install dependencies:

git clone git@github.com:prisma/prisma-examples.git --depth=1
cd prisma-examples/accelerate/remix-starter
npm install

2. Configure environment variables

Copy the .env.example env file in the root of the project directory:

cp .env.example .env

Now, open the .env file and set the DATABASE_URL environment variable with the value of your Accelerate connection string:

# .env

# Accelerate connection string (used for queries by Prisma Client)
DATABASE_URL="__YOUR_ACCELERATE_CONNECTION_STRING__"

Note that __YOUR_ACCELERATE_CONNECTION_STRING__ is a placeholder value that you need to replace with the value of your Accelerate connection string. Notice that the Accelerate connection string has the following structure: prisma://accelerate.prisma-data.net/?api_key=__YOUR_ACCELERATE_API_KEY__.

3. Run a migration to create the Quotes table and seed the database

The Prisma schema file contains a single Quotes model. You can map this model to the database and create the corresponding Quotes table using the following command:

npx prisma migrate dev --name init

You now have an empty Quotes table in your database. Next, run the seed script to create some sample records in the table:

npx prisma db seed

4. Generate Prisma Client

Generate Prisma Client with the following command:

npx prisma generate

5. Start the app

You can run the app with the following command:

npm run dev

The application will start on PORT 5173 and you should be able to see the performance and other stats (e.g. cache/hit) for the different Accelerate cache strategies at the bottom of the UI:

This application queries the most recent Quote with all the different cache strategies available in Accelerate.

Optionally, to add your own quote and see the caching strategies in action, you can add a new quote through Prisma Studio by running the following command:

npx prisma studio

Once the Prisma Studio is running, you can add a new quote by clicking on the Quotes table and then the Add Record button as shown in the screenshot below.

After adding a new record, you can refresh the Remix application to see the new quote and the caching strategies in action.

Resources

• Accelerate Speed Test
• Accelerate documentation
• Check out the Prisma docs
• Join our community on Discord to share feedback and interact with other users.
• Subscribe to our YouTube channel for live demos and video tutorials.
• Follow us on X for the latest updates.
• Report issues or ask questions on GitHub.