Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 1.7 KB

README.md

File metadata and controls

35 lines (19 loc) · 1.7 KB

Notes

Notes is simple note-taking application, which serves as a demo for DataPeps. This application may also be a good starter for anyone interested in the Go/React stack.

Mandatory screenshot

Directory structure

  • /server contains a REST service built with Go and SQLite
  • /client contains a web client built with React

Please refer to each directory README to build and run.

Adding DataPeps

Notes was built as a tutorial for the implementention of End-to-End Encryption (E2EE) with DataPeps. Thanks to E2EE, Notes will be strongly protected with encryption performed directly on client devices. Anyone that can access servers legally (admins, ...) or not (attackers, ...) will not be able to read user information.

This branch already has DataPeps support built-in. What was done from the parent commit is detailed below.

Adding DataPeps support requires no modification of the server code. Only the client/ needs to be updated.

To add DataPeps support, awaiting the forthcoming blog post:

  1. Checkout the datapeps branch git checkout datapeps
  2. To review the datapeps integration git diff master datapeps

There are wonderful slides available as well. And if they're not, please tell us in the issues!

Warning

Passwords are stored unencrypted in the database. It is not a problem when using Notes with DataPeps, but it should not be run as such without.

License

Released under the Apache License