Maskbook ·

Encrypt your posts & chats on You-Know-Where. Allow only your friends to decrypt.

For general introductions, see https://Maskbook.io/

Install Maskbook

Documentation for developers

• License: AGPL
• Code Style: Use prettier
• Git flow enabled, master as the latest branch, released as the stable branch
• UI developing: Use yarn start / npm start to start a Storybook
• Extension developing: Use yarn watch / npm run watch to start watch build for extension
• Crypto: We're using ECDH SECP256-k1 and AES-CBC
• Data transfer between users: We're using gun.js

Prepare

After Maskbook and @holoflows/kit gets stable, we will directly add @holoflows/kit as a dependency. Currently, you need to install and build the latest version of @holoflows/kit.

Install dependencies

• yarn install

Prepare for library @holoflows/kit

• cd ..
• git clone https://github.com/DimensionFoundation/Holoflows-kit.git
• cd Holoflows-kit
• yarn install
• yarn build
• yarn link
• cd ../Maskbook

Install @holoflows/kit in Maskbook

• yarn link @holoflows/kit

Folder Structure

• ./public - Resource file
• ./src/components - UI Components
• ./src/crypto - Crypto related
• ./src/key-management - How we manage keys and user infos
• ./src/utils - Utils
• ./src/extension
• • ./background-script - Scripts that running in the background page as a service
• • ./content-script - Script that be injected into the web page