https://github.com/wallix/notes

Notes is simple note-taking application, which serves as a demo for DataPeps
https://github.com/wallix/notes

Last synced: about 1 year ago
JSON representation

Notes is simple note-taking application, which serves as a demo for DataPeps

• Host: GitHub
• URL: https://github.com/wallix/notes
• Owner: wallix
• License: other
• Created: 2018-11-15T13:06:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-22T04:36:04.000Z (over 4 years ago)
• Last Synced: 2025-04-18T08:39:45.620Z (about 1 year ago)
• Language: JavaScript
• Size: 742 KB
• Stars: 21
• Watchers: 5
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Notes

Notes is simple note-taking application, which serves as a demo for [DataPeps](https://datapeps.com). This application may also be a good starter for anyone interested in the Go/React stack.

![Mandatory screenshot](https://user-images.githubusercontent.com/33936597/50092430-604d7f00-020e-11e9-9284-7b2b142c7b5d.png)

# 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)](https://en.wikipedia.org/wiki/End-to-end_encryption) with [DataPeps](https://github.com/wallix/datapeps-sdk-js). 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](https://github.com/wallix/notes/files/2686280/DataPeps.Notes.Demo.pdf) 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