/explorook

Rookout's site addon to support local files and folders

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Rookout logo

Rookout desktop app

The Rookout desktop app makes it easy to view local files in your browser.

About

CircleCI GitHub release Github all releases Maintenance GitHub contributors GitHub license Known Vulnerabilities Twitter Follow

Rookout is a data extraction and pipelining platform, which provides the ability to collect any piece of data from live code, on-demand, using non-breaking breakpoints (Learn more about Rookout on our website or our docs pages).

The Rookout desktop app ("explorook") allows you to navigate through your local projects in a simple and flexible manner. Use this app in combination with the Rookout web debugger to set non-breaking breakpoints in your source files, and to instantly apply them to live code.

Rookout Desktop App

  • Ease of use - set up once and easily access any directory or file you choose directly from the browser. No need to manually open or refresh files and folders; no additional privileges needed.
  • Git aware - seamlessly access your source code across all devices where the app is installed, regardless of the local paths to which you’ve cloned a git repository to. Easily collaborate with fellow developers working on the same code base.
  • Security- maintain strict control over the files you open for sharing and the websites that can access them. Rookout will never collect or modify your source code.

Security

At Rookout we take your source code security very seriously. Rookout will never collect or modify your source code.

The Rookout Desktop App was designed with security as a foremost concern, its security features are as follows:

  • The App only listens for connections from localhost.
  • The App only allows access from the Rookout app.

Learn more about our security standards

Installation

The desktop app can be installed from within the Rookout web UI, such as when initially selecting a project and indicating use of local code. A link is offered to download the app (which will be customized to your operating system, and which will offer the latest available installer for the Rookout Desktop App). Here's a brief video of that workflow: https://youtu.be/watch?v=mkMpzQPNcsI

Contributing

There are many ways in which you can participate in the project, for example:

If you are interested in fixing issues and contributing directly to the code base, please reach out to support@rookout.com.

Feedback

Requirements

Node.js

This project supports Node.js version 18 and above. Ensure that you have Node.js v18.19.30 or later installed on your system to use this project effectively.

Operating System

While this project is designed to run on various operating systems, it does not support Windows 7 or Windows 8. We recommend using Windows 10/11, macOS, or a Linux distribution for optimal compatibility and performance.

License

Copyright (c) Rookout LTD. All rights reserved.

Licensed under the Apache 2.0 license.