Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

create-redwood-app

Package Overview
Dependencies
Maintainers
0
Versions
7001
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

create-redwood-app

  • 8.4.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
956
increased by3.46%
Maintainers
0
Weekly downloads
 
Created
Source

RedwoodJS


The App Framework for Startups

Ship today with architecture for tomorrow.

Redwood is an opinionated 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 =20.x.

yarn create redwood-app my-redwood-app
cd my-redwood-app
yarn install
yarn redwood dev

Resources

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

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

Local Development

Installation Script

The installation script is built with Yargs.

Template Codebase

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

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

First, run the following commands in the root of the monorepo:

yarn install
yarn build

Then, navigate to the create redwood app package:

cd packages/create-redwood-app

Run yarn node on the built file (dist/create-redwood-app.js) and pass in the path to the new project:

yarn node ./dist/create-redwood-app.js /path/to/new/redwood-app

[!NOTE] the new project will install with the most recent major 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

FAQs

Package last updated on 14 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc