@youwol/flux-files

Flux Files

Collection of modules to work with files in Flux

Installation, Build & Test

To install the required dependencies:

yarn 

To build for development:

yarn build:dev

To build for production:

yarn build:prod

To test:

yarn test

To generate code documentation:

yarn doc

Usage

This collection of modules aims at working with files and folders in YouWol. It is built above an abstract drive concept that provides handle to browse, read and write resources from multiple sources (local folder, youwol workspace, google drive, etc).

This package only exposes a drive that enables to browse and use files/folders on your computer. However, most of the modules exposed can work with others type of drive (e.g. YouWol drive, Google drive); new ones can also be created (see developer documentation).

Resources

Here is a list of interesting resources to work with a local filesystem from a browser:

• tutorial
• specification
• API introduction