Dochain repository

An application to save your documents and share them safely
Explore the docs » Contract deployed in Polygon Mainnet»

Table of Contents

1. About the project
   • Built with
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact

About the project

This project consists of storing all kinds of files, images, documents, pdf's, etc, that may contain sensitive information or just that you need to stay private and persistent., the app allow you to create shareable directories and upload files with the freedom to decide who can see that document. directories/files are represented by an ERC1155 token and will be encrypted to ensure privacy.

(back to top)

Built with

To represent directories/files we will use the ERC 1155 standard so that several people can own a directory. For the storage of the files we will not store them in the blockchain, but we use IPFS to store any and then only have to store a URL. To retrieve data on the front-end, we will develop a subgraph that allows us to be more efficient in queries like, 'How many directories/files does a certain person have access to', 'Who are the people who have access to a certain directory/file' For encryption, we will use a metamask compatible cipher in case we cannot work out a more secure private key escrow method.

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• Git Sabrá que lo hizo bien si puede ejecutar git --version y ve una respuesta como git version x.x.x
• Nodejs Sabrá que ha instalado nodejs correctamente si puede ejecutar: node --version y obtenga una salida como: vx.x.x
• yarn Sabrá que ha instalado yarn correctamente si puede ejecutar: yarn --version y obtener una salida como: x.x.x

Installation

1. Clona el repositorio

   git clone https://github.com/Alberto-SC/dochain

2. Instala las dependencias

   yarn

3. Crea un archivo .env e introduce tus llaves, tienes el archvio .env.example como modelo, ejemplo:

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Deploy:

    yarn deploy

Testing:

    yarn test

Test Coverage:

    yarn coverage

(back to top)

License

Distributed under the MIT license. See LICENSE.txt for more information.

(back to top)

Contact

👤 Alberto Silva Cazares

• GitHub: @Alberto-SC

👤 José Piña

• GitHub: @pinajmr
• Twitter: @pinajmr
• LinkedIn: José Piña

(back to top)