Development setup¶
Simply follow the instructions to run Relay from source above, on your own fork.
Before submitting any change, make sure to:
- Read the Contributing instructions
- Run
npm testto execute linters and the test suite- Run
npm run format:prettierif linting fails
- Run
- Run
npm run build:clientif you change or add anything inclient/jsorclient/components- The built files will be output to
public/by Vite
- The built files will be output to
- Run
npm run build:serverif you change anything inserver/- The built files will be output to
dist/by tsc
- The built files will be output to
npm run devcan 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.