create-jtoar2

The App Framework for Startups

Ship today with architecture for tomorrow.

Redwood is an opinionated, edge-ready framework for modern multi-client applications, built on React, GraphQL, and Prisma with full TypeScript support and ready to go with zero config.

Want great developer experience and easy scaling? How about an integrated front- and back-end test suite, boilerplate code generators, component design, logging, API security + auth, and serverless or traditional deploy support? Redwood is here! Redwood works with the components and development workflow you love but with simple conventions and helpers to make your experience even better.

Quick Start

Redwood requires Node.js >=14.x <=16.x and Yarn v1.15 (or newer).

yarn create redwood-app redwood-project
cd redwood-project
yarn redwood dev

Resources

• The Redwood Tutorial: The best way to learn Redwood
• The Redwood CLI: code generators, DB helpers, setup commands, and more
• Documentation and How To's
• Join the Community Forums and Chat

Contributing to create-redwood-app

Contributors are Welcome! Get started here. And don't hesitate to ask for help on the forums and chat

Table of Contents

• Description
• Package Leads
• Roadmap
• Local Development
  • Installation Script
  • Template Codebase
  • How to run create-redwood-app and create a project
  • Develop using the new project

Description

This package creates and installs a Redwood project, which is the entry point for anyone using Redwood. It has two parts:

• The installation script create-redwood-app.js
• Project template code in the template/ directory

For information about contributing to the Redwood Framework in general, please start here.

Package Leads

• @peterp
• @thedavidprice

Roadmap

v1 Priorities:

• convert template/ codebase to TypeScript
• add option to install as either TypeScript or JavaScript project (defaults to TypeScript)
• add package tests, which may be accomplished by including in Cypress E2E CI

Local Development

Installation Script

The installation script is built with Yargs

Template Codebase

The project codebase in template/ uses Yarn Workspace v1 for a monorepo project containing the API and Web Sides. Redwood packages are included in template/package.json, template/web/package.json, and template/api/package.json, respectively.

How to run create-redwood-app from your local repo and create a project

Make sure you to first run yarn install in your project root.

Step into the create-redwood-app package and run the script:

cd packages/create-redwood-app
yarn babel-node src/create-redwood-app.js /path/to/new/redwood-app

This will create a new project using the local template/ codebase

Note: the new project will install with the most recent stable Redwood package version by default

How to run other published versions for debugging

By default yarn create will pick the latest stable version to run, but you can specify a different version via yarn too!

To try the canary version, run:

npx create-redwood-app@canary /path/to/project

Note that this will still create a project with the latest stable version, but run the canary version of create-redwood-app, and is mainly useful for debugging this package, and not the redwood canary release.

You can specify any tag or version instead of @canary

Develop using the new project

There are three options for developing with the installed project:

1. Upgrade the project to use the latest canary release

cd /path/to/new/redwood-app
yarn rw upgrade -t canary

2. Use the workflow and tools for local package development

• Local Development Instructions