Getting Started Into Development

Edit this page

To contribute or make your own custom page builder elements you’ll need to run Relax in development mode. First start by cloning Relax’s repo if you haven’t already:

1
2
git clone git@github.com:relax/relax.git
cd relax

After this you just have to install the dependencies using Yarn:

1
yarn

And then you can run Relax in dev mode:

1
yarn dev

First build might take up to a minute or two but don’t worry it has a fast hot reloading build after. You know it’s ready when you see the message debug: URL: http://localhost:8080.

This means you can now open Relax at http://localhost:8080. You might be redirected to the init route if you still don’t have any users, if this is the case create an user and login.