Installing

Edit this page

Dependencies

Relax uses sharp to resize images. If you’re using OS X and have libvips installed globally, e.g. via brew, it may cause problems with sharp’s compilation. You may need to uninstall via brew remove libvips. See https://github.com/lovell/sharp/issues/602 for more information.

You’ll also need yarn and MongoDB.

Install

Installation is pretty straightforward if you have all the needed dependencies. Start by cloning the Relax repo:

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

Then you just need to install the dependencies, build the project and run the application:

1
2
3
yarn
yarn build
yarn start

That’s it! After these commands finish Relax will tell you it’s running.

Configuration

To configure the application you can use a .relaxrc file. You can place it next to the application, on any parent folder, in your HOME folder, etc.

You can find a sample with the default values here.