Newcomers

SEE ISSUES / CREATE ISSUES / SOLVE ISSUES

Slack Channel:

https://join.slack.com/share/I0104BSNDCJ/tglyB7qOob1gK7nMuLltKu3N/enQtMTAwNDQwMDc2MTQyNi1kODlmMTFjYzM0ZTY2ODJlOGNhODk2NGE5MjQ4MzMwZTYyZGQzYzEzNDRkNTdiY2I5MTllOGU5NjdmNDMzYzZh

Redwood

HEADS UP: RedwoodJS is NOT ready for use in Production. It relies heavily on Prisma2, which is currently in testing with an expected production release coming soon. See status at "Is Prisma2 Ready?"

Getting Started

• Redwoodjs.com: home to all things RedwoodJS.
• Tutorial: getting started and complete overview guide.
• Docs: using the Redwood Router, handling assets and files, list of command-line tools, and more.
• Redwood Community: get help, share tips and tricks, and collaborate on everything about RedwoodJS.

Setup

We use Yarn as our package manager. To get the dependencies installed, just do this in the root directory:

yarn install

Fire it up

yarn redwood dev

Your browser should open automatically to http://localhost:8910 to see the web app. Lambda functions run on http://localhost:8911 and are also proxied to http://localhost:8910/api/functions/*.

Development

Database

We're using Prisma2, a modern DB toolkit to query, migrate and model your database.

Prisma2 is not ready for production at the moment.

To create a development database:

yarn redwood db up

This will read the schema definition in api/prisma/schema.prisma and generate a sqlite database in api/prisma/dev.db

If you've made changes to the schema run yarn redwood db save to generate a migration, and yarn redwood db up to apply the migration/ generate a new ORM client.