Development setup

Simply follow the instructions to run Relay from source, on your own fork.

Before submitting any change, make sure to:

• Run npm test to execute linters and the test suite
  • Run npm run format:prettier if linting fails
• Run npm run build:client if you change or add anything in client/js or client/components
  • The built files will be output to public/ by Vite
• Run npm run build:server if you change anything in server/
  • The built files will be output to dist/ by tsc
• npm run dev can be used to start Relay with hot module reloading

To ensure that you don't commit files that fail linting, you can install a pre-commit git hook. Execute npm run githooks-install to do so.

Responsible Disclosure of Security Vulnerabilities

• Do not open public issues to report security vulnerabilities.
• Contact us privately first, in a responsible disclosure manner.
• On IRC, send a private message to any voiced user in #relay on irc.ouch.chat.
• By email, send your report to security@zrgameworks.com.