graphql README

The project's README from github.com/redwoodjs/graphql. As one markdown file: README.md.

RedwoodGraphQL

by Tom Preston-Werner, Peter Pistorius, Rob Cameron, David Price, and more than 250 amazing contributors (see end of file for a full list).

NOTE

⚡ Big News — We’ve launched RedwoodSDK, a modern React framework for building full-stack web apps on Cloudflare.


🌲 RedwoodSDK — React on Cloudflare

RedwoodSDK starts as a Vite plugin and unlocks:

All while keeping to web standards — you write with native Request/Response and the modern Web APIs you already know.


🚀 Try it in seconds

npx create-rwsdk my-project-name
cd my-project-name
npm run dev

📚 Read the docs
⚡ Quick Start Guide


🙌 How You Can Help

We’d love for the Redwood community to be part of this from day one:

  1. Try it out — Follow the Quick Start and build something small.
  2. Give feedback — Tell us what works, what’s confusing, and what could be better.
  3. Spread the word — Share RedwoodSDK with your friends, coworkers, and followers.
  4. Star the repo — Stars help more developers discover RedwoodSDK.


Thank you for being part of the Redwood journey — we can’t wait to see what you build with RedwoodSDK! ❤️


RedwoodJS GraphQL

Bighorn Epoch (current development epoch)

NOTE: This section of the Readme is aspirational for the current development epoch we call Bighorn. Bighorn has not yet been released, but when it is, it will fulfill the promises of what you read below. If you’d like to help us on this journey, please say hi in the Community Forums!

Redwood is a framework for quickly creating React-based web applications that provide an amazing end user experience. Our goal is to be simple and approachable enough for use in prototypes and hackathons, but performant and comprehensive enough to evolve into your next startup.

We accomplish this in two primary ways:

  1. Redwood is opinionated and full-stack. We’ve chosen the best technologies in the JS/TS ecosystem and beautifully integrated them into a cohesive framework that lets you get things done instead of endlessly evaluating technology options. You can get started using Redwood without a backend, but the framework really shines when you’re building a data driven application. Our transparent data fetching and optional GraphQL API make building and growing your application easier than you expect!

  2. Redwood’s declarative data fetching and simple form submission features are built on top of RSC + Server Actions and simplify common use cases so you can focus on your users’ experience. Creating the best, most responsive user interfaces requires reasoning about whether code should execute on the server or the client. Redwood makes it easy to choose the best execution context for your code by leveraging the power of React Server Components.

The entire framework is built with TypeScript, so you get type safety from the router to the database and everywhere in-between. If you’d rather build your app with JavaScript, you can do that too, and still enjoy great code completion features in your favorite editor.

TRY BIGHORN: While Bighorn does not yet have a production release, we do publish the latest code as canaries, and we welcome you to experiment with them! The best way to get familiar with these canaries is to keep an eye on the Redwood Blog.

Arapahoe Epoch (current stable release)

Redwood is an opinionated, full-stack, JavaScript/TypeScript web application framework designed to keep you moving fast as your app grows from side project to startup.

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. Out of the box you get tightly integrated testing with Jest, logging with Pino, and a UI component catalog with Storybook. Setting up authentication (like Auth0) or CSS frameworks (like Tailwind CSS) are a single command line invocation away. And to top it off, Redwood's architecture allows you to deploy to either serverless providers (e.g. Netlify, Vercel) or traditional server and container providers (e.g. AWS, Render) with nearly no code changes between the two!

By making a lot of decisions for you, Redwood lets you get to work on what makes your application special, instead of wasting cycles choosing and re-choosing various technologies and configurations. Plus, because Redwood is a proper framework, you benefit from continued performance and feature upgrades over time and with minimum effort.

TUTORIAL: The best way to get to know Redwood is by going through the extensive Redwood Tutorial. Have fun!

QUICK START: You can install and run a full-stack Redwood application on your machine with only a couple commands. Check out the Quick Start guide to get started.

DOCS: Visit the full RedwoodJS Documentation for extensive reference docs and guides.

About

Redwood is the latest open source project initiated by Tom Preston-Werner, cofounder of GitHub (most popular code host on the planet), creator of Jekyll (one of the first and most popular static site generators), creator of Gravatar (the most popular avatar service on the planet), author of the Semantic Versioning specification (powers the Node packaging ecosystem), and inventor of TOML (an obvious, minimal configuration language used by many projects).

Technologies

We are obsessed with developer experience and eliminating as much boilerplate as possible. Where existing libraries elegantly solve our problems, we use them; where they don't, we write our own solutions. The end result is a JavaScript development experience you can fall in love with!

Here's a quick taste of the technologies a standard Redwood application will use:

If you'd like to use our optional built-in GraphQL API support, here's our stack:

Roadmap

A framework like Redwood has a lot of moving parts; the Roadmap is a great way to get a high-level overview of where the framework is relative to where we want it to be. And since we link to all of our GitHub project boards, it's also a great way to get involved! Roadmap

Why is it called Redwood?

(A history, by Tom Preston-Werner)

Where I live in Northern California there is a type of tree called a redwood. Redwoods are HUGE, the tallest in the world, some topping out at 115 meters (380 feet) in height. The eldest of the still-living redwoods sprouted from the ground an astonishing 3,200 years ago. To stand among them is transcendent. Sometimes, when I need to think or be creative, I will journey to my favorite grove of redwoods and walk among these giants, soaking myself in their silent grandeur.

In addition, Redwoods have a few properties that I thought would be aspirational for my nascent web app framework. Namely:

And there you have it.

Contributors

A gigantic "Thank YOU!" to everyone below who has contributed to one or more Redwood projects: Framework, Website, Docs, and Create-Redwood Template. 🚀

Core Team: Leadership


Amy Haywood Dutton

David Price

Tobbe Lundberg

Tom Preston-Werner

Core Team: Maintainer and Community Leads


David Thyresson

maintainer

Daniel Choudhury

maintainer

Keith T Elliot

community

Barrett Burnworth

community

Josh GM Walker

maintainer

Founders


Tom Preston-Werner

Peter Pistorius

Rob Cameron

David Price

Core Team: Alumni


Aldo Bucchi


Aditya Pandey


Amanda Giannelli


Alice Zhao


Simon Gagnon


Chris van der Merwe


Ryan Lockard


Peter Colapietro

noire.munich

Forrest Hayes


Robert


Anthony Campolo


Claire Froelich


Kim-Adeline Miguel


Dominic Saadi


Kris Coulson

All Contributors


Anton Moiseev

Mohsen Azimi

Christopher Burns

Terris Kremer

James George

Brett Jackson

Guilherme Pacheco

Kasper Mikiewicz

chris-hailstorm

Jai

Lachlan Campbell

Satya Rohith

Steven Normore

Mads Rosenberg

Ted Stoychev

eurobob

Vikash

graphql (redwoodjs/graphql)

Searching Database…

17.6K ·GitHub
这是什么?Redwood 是一个有自己一套主张的全栈 JavaScript/TypeScript Web 应用框架:前端用 React,后端接一个 GraphQL API,数据库层用 Prisma,目标是带你从原型一路做到创业产品。
它只是前端的东西,还是后端也管?两头都管:一个 Redwood 应用是 React 前端搭配一个自定义的 GraphQL API,数据库用 Prisma。GraphQL 这一层是可选的,但数据驱动的应用才是这个框架最出彩的地方。
搭起我的第一个 Redwood 应用要做什么?只要几条命令——快速入门指南就能让一个全栈应用在你的电脑上安装并跑起来,官方还推荐通过内容详尽的教程来学习这个框架。
测试、日志和样式工具都要我自己挑吗?不用——开箱就带 Jest 做测试、Pino 做日志和 Storybook,要加 Auth0 这样的登录认证或 Tailwind 这样的 CSS 框架,也只需一条命令。
这个框架现在稳定吗,能直接拿来干活吗?当前的稳定版本没问题,但下一个大版本 Bighorn 还没发布——它承诺的功能还只是愿景,目前只能通过实验性的 canary 构建体验。
Redwood 是给周末随便玩玩的,还是给真正的创业项目用的?两者都是,这是它的设计目标:足够简单易上手,适合做原型和黑客松;又足够高性能、功能全面,能一路成长为你的下一个创业项目。
用 Redwood 做的应用可以部署到哪里?既可以部署到 Netlify、Vercel 这类 Serverless 平台,也可以部署到 AWS、Render 这类传统服务器和容器服务商,两者之间几乎不需要改代码。
RedwoodSDK 是什么?是同一个团队新推出的姊妹项目:在 Cloudflare 上跑 React。它以 Vite 插件的形式起步,提供 SSR、React Server Components、Server Functions、流式响应和实时能力,还能一级集成 Cloudflare 的 Workers、D1、Durable Objects 和 R2 等服务。
为什么叫 Redwood(红杉)?得名于北加州的巨大红杉树,作者认为它对 Web 框架是一种激励:树苗时就好看,长成后雄伟;松果小而密集(用更少的代码做更多的事);抗火(健壮性);远看复杂,近看却很简单。
它在底层用了哪些 GraphQL 库?可选的内置 API 在服务端基于 GraphQL Yoga 和 Envelop 构建,React 前端用 Apollo Client,数据库则由 Prisma 负责。
它能帮我决定哪些代码跑在服务端、哪些跑在浏览器里吗?能——它的声明式数据获取和表单提交建立在 React Server Components 和 Server Actions 之上,为每段代码选对运行环境本身就是框架的一部分。
What are similar projects?wasp, open-saas, kit, gatsby, nitro, vinext, ice, gin-vue-admin
Creator
redwoodjs
Size
447.9 MB
Stars
17.6K
Age
7y
Commits · 90 Days