Skip to main content
Version: 3.1

Introduction

Redwood is the full-stack web framework designed to help you grow from side project to startup. Redwood features an end-to-end development workflow that weaves together the best parts of React, GraphQL, Prisma, TypeScript, Jest, and Storybook. For full inspiration and vision, see Redwood's README.

Development on Redwood happens in the redwoodjs/redwood repo on GitHub. The docs are there too. While Redwood's founders and core team handle most of the high-priority items and the day-to-day, Redwood wouldn't be where it is without all its contributors! Feel free to reach out to us on the forums or on Discord, and follow us on Twitter for updates.

Getting the Most out of Redwood

To get the most out of Redwood, do two things:

The tutorial is the best way to start your Redwood adventure. It's readable, feature-ful, and fun. You'll go all the way from git clone to Netlify deploy! And by the end, you should feel comfortable enough to start that side project.

After you've read the tutorial and started your side project, come say hi and tell us all about it by joining the community. Redwood wouldn't be where it is without the people who use and contribute to it. We warmly welcome you!

How these Docs are Organized

As you can probably tell from the sidebar, Redwood's docs are organized into three sections:

The order isn't arbitrary. This is more or less the learning journey we have in mind for you.

While we expect you to read the tutorial from top to bottom (maybe even more than once?), we of course don't expect you to read the Reference and How To sections that way. The content in those sections is there on an as-needed basis. You need to know about the Router? Check out the Router reference. You need to upload files? Check out the File Uploads how to.

That said, there are some references you should consider reading at some point in your Redwood learning journey. Especially if you want to become an advanced user. For example, Services are fundamental to Redwood. It's worth getting to know them inside and out. And if you're not writing tests and stories, you're not using Redwood to its full potential.

We realize that the content doesn't always match the organization

For example, half the Testing reference reads like a tutorial, and half the Logger reference read like a how to. Till now, we've focused on coverage, making sure we had content on all of Redwood's feature somewhere at least. We'll shift our focus to organization and pay more attention to how we can curate the experience.