Using GitPod

What is GitPod?

GitPod is a cloud development environment with all the necessary tools and dependencies, allowing you to focus on building your RedwoodJS application without worrying about the setup. Get started quickly and efficiently by launching RedwoodJS inside GitPod!

Getting Started

Click on the Open in GitPod button:

This will launch GitPod and ask you to configure a new workspace. Click continue.

GitPod will then begin to build your workspace. This may take several minutes.

What's going on behind the scenes:

• GitPod is setting up the workspace
• It installs our recommended VS Code plugins:
  • ESLint
  • Git Lens
  • VS Code Language - Babel
  • VS Code Version Lens
  • Editor Config
  • Prisma
  • VS Code GraphQL
• It runs our Create Redwood App which will install the latest stable version of Redwood. We're setting this project to use TypeScript, however, you can change it to JavaScript if you prefer.
• It runs yarn install, adding all the dependencies for the project
• Changes the database over to Postgres

Once everything is up and running, you can click on the Ports tab:

You can click on the address or the globe icon to open that particular port in a new tab.

• Port 5432 is the database. So, if you click on that port, you'll probably see a "Port 5432 Not Found" error, but it is working!

• Port 8910 is your frontend

• Port 8911 is your backend and will show you a list of all available functions. If you add /graphql to the end of the URL, you should see the GraphQL Playground

How to Use GitPod

If you have an existing project, you can still use GitPod:

1. Take any repository within GitHub and append gitpod.io/# to the URL. This will quickly launch a GitPod workspace.
2. Within the Terminal, run yarn install to install all the dependencies