Let's take a look at the files and directories that were created for us (config files have been excluded for now):
Don't worry about trying to memorize this directory structure right now, it's just a brief overview to get you oriented. Seeing dozens of files before you've even written a single line of code can be daunting, but there's a great organizational structure here, promise. You can also ignore this all for now and we'll touch upon many of these files and directories as we go.
At the top level we have three directories,
web. Redwood separates the backend (
api) and frontend (
web) concerns into their own paths in the codebase. (Yarn refers to these as "workspaces". In Redwood, we refer to them as "sides.") When you add packages going forward you'll need to specify which workspace they should go in. For example (don't run these commands, we're just looking at the syntax):
scripts is meant to hold any Node scripts you may need to run from the command line that aren't directly related to the api or web sides. The file that's in there,
seed.js is used to populate your database with any data that needs to exist for your app to run at all (maybe an admin user or site configuration).
api there are four directories:
dbcontains the plumbing for the database:
schema.prismacontains the database schema (tables and columns)
After we add our first database table there will also be a SQLite database file named
dev.dband a directory called
migrationscreated for us.
migrationscontains the files that act as snapshots of the database schema changing over time.
distcontains the compiled code for the api side and can be ignored when developing.
srccontains all your backend code.
api/srccontains five more directories:
directiveswill contain GraphQL schema directives for controlling access to queries and transforming values.
functionswill contain any lambda functions your app needs in addition to the
graphql.jsfile auto-generated by Redwood. This file is required to use the GraphQL API.
graphqlcontains your GraphQL schema written in a Schema Definition Language (the files will end in
libcontains a few files:
auth.jsstarts as a placeholder for adding auth functionality and has a couple of bare-bones functions in it to start,
db.jsinstantiates the Prisma database client so we can talk to a database and
logger.jswhich configures, well, logging. You can use this directory for other code related to the API side that doesn't really belong anywhere else.
servicescontains business logic related to your data. When you're querying or mutating data for GraphQL (known as resolvers), that code ends up here, but in a format that's reusable in other places in your application.
typescontains automatically compiled GraphQL types and can be ignored during development
That's it for the backend.
publiccontains assets not used by React components (they will be copied over unmodified to the final app's root directory):
favicon.pngis the icon that goes in a browser tab when your page is open (apps start with the RedwoodJS logo).
README.mdexplains how, and when, to use the
publicfolder for static assets. It also covers best practices for importing assets within components via Webpack. You can also read this README.md file on GitHub.
robots.txtcan be used to control what web indexers are allowed to do.
srccontains several subdirectories:
componentscontains your traditional React components as well as Redwood Cells (more about those soon).
layoutscontain HTML/components that wrap your content and are shared across Pages.
pagescontain components and are optionally wrapped inside Layouts and are the "landing page" for a given URL (a URL like
/articles/hello-worldwill map to one page and
/contact-uswill map to another). There are two pages included in a new app:
NotFoundPage.jswill be served when no other route is found (see
FatalErrorPage.jswill be rendered when there is an uncaught error that can't be recovered from and would otherwise cause our application to really blow up (normally rendering a blank page).
App.jsthe bootstrapping code to get our Redwood app up and running.
index.cssis a good starting place for custom CSS, but there are many options (we like TailwindCSS which, believe it or not, may not require you to write any custom CSS for the life of your app!)
index.htmlis the standard React starting point for our app.
Routes.jsthe route definitions for our app which map a URL to a Page.
We'll dip in and out of these directories and files (and create some new ones) as we work through the tutorial.