Skip to content
Get packs

Guide · Open source

How to use RedwoodGraphQL: clone, setup and key facts

Updated · written with AI from the project's own documentation and checked against our catalogue data

RedwoodGraphQL is the GraphQL-focused repository of the Redwood web framework, which combines a React frontend, a GraphQL API and a Prisma-based database layer in one project. This guide is for developers who want to understand what the repository contains, how to clone it, and whether it fits a data-driven React app. By the end you will know what the README actually covers, what it leaves out, and which parts are stable versus still in development.

RedwoodGraphQLredwoodjs/graphql · ★ 17.6k · MIT

Quick start

  1. 1Check prerequisites. Install Node.js. The README excerpt does not state a version, so confirm the requirement in the official Redwood docs.
  2. 2Clone the repository. Run git clone https://github.com/redwoodjs/graphql to copy the source to your machine.
  3. 3Read the README sections. Separate RedwoodSDK, the stable Arapahoe release and the unreleased Bighorn epoch so you know which features you can rely on.
  4. 4Follow the Quick Start. Use the Redwood Quick Start guide linked in the README to set up a full-stack app on your machine.
  5. 5Work through the tutorial. The README recommends the Redwood Tutorial as the best way to learn the framework.
  6. 6Check the database layer. Redwood uses Prisma to operate on the database, so review Prisma's setup as part of your project.

What is RedwoodGraphQL?

RedwoodGraphQL is the GraphQL-focused repository of the Redwood framework. The README describes Redwood as opinionated and full-stack, meant to let developers skip choosing every tool themselves.

At the highest level, a Redwood app is a React frontend that talks to a custom GraphQL API. The API uses Prisma to operate on a database. The framework is written in TypeScript, and the README says you can also build with JavaScript if you prefer.

  • React frontend
  • Custom GraphQL API, with optional GraphQL support
  • Prisma for database access
  • Testing with Jest, logging with Pino and a Storybook component catalog (stable release)
  • Licence: MIT

Know what the README covers before you start

The README is mixed. Its top section promotes RedwoodSDK, which the README describes as a separate project for building full-stack apps on Cloudflare. Later sections describe the Redwood framework and a Bighorn epoch that the README says has not yet been released.

Read the sections as separate things. The Arapahoe section describes the current stable release. The Bighorn section is described as aspirational and says it has no production release yet, though the latest code is published as canaries.

  • RedwoodSDK: a separate project, a Vite plugin for React on Cloudflare
  • Arapahoe epoch: the current stable release of Redwood
  • Bighorn epoch: in development, no production release yet

Get the RedwoodGraphQL source

The only install command in the README excerpt is a git clone of the repository. You need Node.js as a prerequisite, but the README excerpt does not state which version, so check the official docs before installing.

The README points to a Quick Start guide and full documentation for setting up a Redwood app, which are separate from the clone step shown here.

  • Install Node.js (the version is not stated in the README excerpt)
  • Clone the repository with the command below
  • Follow the linked Redwood Quick Start for app setup
git clone https://github.com/redwoodjs/graphql

Understand the Redwood stack

The README lists the technologies a standard Redwood application uses, including React, Vite, Prisma, Jest, Storybook and Pino. For the optional GraphQL API, the stack listed is GraphQL, GraphQL Yoga, Envelop and Apollo Client.

The README says Redwood's declarative data fetching and simple form submission features are built on React Server Components and Server Actions. Those features are described in the Bighorn section, so treat them as in development rather than available now.

  • Frontend: React, with Vite
  • Data: Prisma, with a database of your choice
  • API (optional): GraphQL, GraphQL Yoga, Envelop, Apollo Client
  • Testing and tooling: Jest, Storybook, Pino

Decide if it fits your project

The README frames Redwood around data-driven applications. You can start without a backend, but the framework is described as shining when you build a data-driven app with the optional GraphQL API.

Redwood also says it can deploy to serverless providers such as Netlify and Vercel, or to traditional server and container providers such as AWS and Render, with nearly no code changes between the two.

  • Good fit: data-driven React apps, prototypes and hackathons that may grow, TypeScript end to end
  • Poor fit: a small static site, non-developers, teams that need unreleased Bighorn features now

What people use it for

  • Building a data-driven React app with a custom GraphQL API
  • Prototyping an idea at a hackathon that may later grow into a larger product
  • Creating a TypeScript project where types run from the router to the database
  • Deploying a full-stack app to serverless or container hosts with minimal code changes

Frequently asked questions

Is RedwoodGraphQL free to use?

The repository is licensed under MIT, as stated in the project information. The README excerpt does not discuss pricing for hosting or any paid services.

What do I need to install RedwoodGraphQL?

The README lists Node.js as a prerequisite but does not state a version in the excerpt. The only install command shown is git clone https://github.com/redwoodjs/graphql. Check the Redwood Quick Start for the rest of the setup.

Is RedwoodGraphQL the same as RedwoodSDK?

No. The README describes RedwoodSDK as a separate project for building full-stack web apps on Cloudflare. RedwoodGraphQL covers the Redwood framework and its optional GraphQL API.

Is Bighorn ready for production?

No. The README says Bighorn has not yet been released, although the latest code is published as canaries for people who want to experiment.

How does RedwoodGraphQL compare to Next.js or Remix?

The project information lists Next.js, Remix, Blitz.js and T3 Stack as comparable projects. The README excerpt does not include a direct comparison, so evaluate them against your own needs.

Why is it called Redwood?

The README says creator Tom Preston-Werner chose the name after redwood trees, which he describes as tall, long-lived and fire resistant. He says those traits inspired the framework's goals.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

RedwoodGraphQL suits developers building data-driven React apps who want a pre-assembled TypeScript stack, and prototypes that may grow. It is a poor choice for small static sites, non-developers, or teams that need the unreleased Bighorn features now.

Install options & downloads