File Tree
File tree is a collection of packages to display and manipulate the file system.
Quick Start
How it works
There are 3 core packages:
- file-tree-server - runs a file system watcher and builds an up-to-date tree data structure. The server passes the initial state and subsequent updates to the client.
- file-tree-client - mirrors the tree data structure from the server, as well as applying updates as they happen. Allows operating on the tree (e.g. creating, renaming, deleting files), applying changes locally, and then updating with the definitive state from the server.
- react-file-tree - a react component to display the file tree in a flexible, performant way.
To sync server and client, you'll need to transport the events from the server to the client. Currently supported servers and clients are:
- electron - example - (main thread adapter, renderer thread adapter)
- socket.io - example - (server adapter, browser adapter)
Building for development/examples
First, clone this repository
git clone https://github.com/dabbott/file-tree.git
cd file-tree
Make sure you have lerna v2 installed globally
npm i -g lerna
Install dependencies for all packages
lerna bootstrap
npm install depencies of the root project, and build
npm i
npm run build