Developing

This project uses gestalt for a server. Gestalt is basically a stripped down version of CryptPad's server, which implements a variety of APIs useful for building cryptographic applications.

Future development

Unfortunately, many of CryptPad's nice serverside APIs require clientside components which cannot yet be readily extracted from its main codebase. Those components will be gradually extracted for reuse as they are required. As they become available, this project will benefit from:

• persistent data storage
  • for mutable documents and their history
  • for encrypted blobs
• cryptographic login which allows you to recover your encryption keys while keeping them secret
  • with the ability to change your password
• the ability to add friends and send them messages while they are offline
• the ability to allow spectators to view a session without joining it
• ...and probably some other stuff that isn't coming to mind at the moment

What you need to know

This project is written in Javascript. It implements libraries which are intended to run as standalone scripts (via nodejs) and in the browser (via browserify).

Included is a basic build system which:

1. lints the javascript and fails early if it is deemed invalid
2. compiles all the javascript into a single file
3. hashes that file and references it from the included HTML using the Sub-resource-integrity API
4. optionally includes a source map for the compiled file, for easier debugging
5. lints and compiles LESS into CSS (if it passes lint)

Where to start

./beacon/src/js/main.js is the entry-point, which implements a very experimental single-page-app framework.