Back to Redwood

Using Ona

docs/docs/how-to/using-ona.md

8.9.03.2 KB
Original Source

Using Ona

What is Ona?

Ona 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 Ona!

Getting started

Click on the Run in Ona button:

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

Ona will then begin to build your workspace using Dev Containers and Automations. This may take several minutes as it:

  1. Sets up the development environment
  2. Installs dependencies
  3. Creates a test project linked to the framework
  4. Starts the development server automatically

What's going on behind the scenes:

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 (Ona)

<iframe width="560" height="315" src="https://www.youtube.com/embed/5pNHaqJWKL4?si=OmkQvmPL_Cc3djLg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

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 Ona environment.
  2. Within the Terminal, run yarn install to install all the dependencies