Back to Sapling

ReviewStack

eden/contrib/reviewstack/README.md

latest2.1 KB
Original Source

ReviewStack

ReviewStack is a novel user interface for GitHub pull requests with custom support for stacked changes. The user experience is inspired by Meta's internal code review tool, but leverages GitHub's design system to achieve a look and feel that is familiar to GitHub users:

A hosted instance of ReviewStack is publicly available at https://reviewstack.dev/. Note that it has no server component (though it does leverage Netlify's OAuth signing to authenticate with GitHub).

Local Development

  • Run yarn in the eden/contrib/reviewstack folder to install all the dependencies.
  • Run yarn codegen in the eden/contrib/reviewstack to build the generated code.
  • Run yarn start in the eden/contrib/reviewstack.dev folder to run a local instance of ReviewStack.

If you make any changes locally, you'll need to regenerate the files and restart your server

The development environment was created using Create React App, so it should be available on http://localhost:3000/ by default.

If you have already authenticated with the GitHub CLI gh, you can run:

bash
gh auth status -t

to dump your GitHub personal access token that you can use with the development instance of ReviewStack.

WARNING: The token will be written to localStorage, and in the course of using the app, various data from GitHub may be written to localStorage or indexedDB for the host localhost:3000. This means that if you ran another development server on port 3000 later on, it would be able to read any of the GitHub data stored locally by ReviewStack! Note that if you click Logout in the ReviewStack UI, it will delete all of the locally stored GitHub data, so be sure to do this before running a different application on port 3000.