README.md

Overview - Running the application on your machine - Documentation

Tanker FileKit Tutorial Application

Overview

Tanker FileKit handles end-to-end encrypted files in your apps. Files are encrypted client-side, before being uploaded, and can only be read by the sender and recipients.

This repository features an example application using Tanker FileKit.

Running the example on your machine

Check your Node.js and Yarn versions, and upgrade if needed:

node -v  # >= 12   (supported version)
yarn -v  # >= 1.0  (workspaces support)

Clone this repository:

git clone https://github.com/TankerHQ/filekit-tuto-app.git

Install all dependencies at once:

yarn

Configure the project for <env> (local, dev, or prod)

cd src/ && ln -s config.<env>.js config.js

Run the application

yarn start

Done! The application should now be reachable at the http://127.0.0.1:3000 URL.

Documentation

Learn more about the tutorial application and Tanker FileKit in the FileKit documentation.