Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hashguard open source website #1869

Open
lilyanB opened this issue Mar 3, 2025 · 0 comments
Open

hashguard open source website #1869

lilyanB opened this issue Mar 3, 2025 · 0 comments
Assignees

Comments

@lilyanB
Copy link

lilyanB commented Mar 3, 2025

Open Grant Proposal: hashguard open source website

Project Name: Hashguard

Proposal Category: Retrieval

Individual or Entity Name: organization

Proposer: HashguardProject

Project Repo(s) https://github.com/HashguardProject/open-website

(Optional) Filecoin ecosystem affiliations: [twinquasar](https://www.twinquasar.io/about)

(Optional) Technical Sponsor: [CID gravity](https://www.cidgravity.com/)

Do you agree to open source all work you do on behalf of this RFP under the MIT/Apache-2 dual-license?: "Yes"

Project Summary

Hashguard makes decentralized storage accessible to everyone, allowing each user to encrypt their files with their own keys before storing them on the blockchain. We use CID Gravity to store these encrypted files on Filecoin. Our application is live and we offer subscriptions to our users. Currently, when a user terminates their subscription, they lose access to our platform and, therefore, to their files.

Given that the files are stored on IPFS for at least six months, our users could theoretically retrieve their files directly from IPFS. This proposal aims to create a simple and intuitive open source website that allows our users to download their files stored on IPFS, even after their subscription has ended. This site will be completely open source and usable by anyone who wants a simple tool to download files from IPFS. This project will allow users to maintain control of their data at all times.

Impact

This project has a significant impact on the Filecoin and IPFS ecosystem by improving the accessibility and portability of data stored in a decentralized manner. It addresses the problem of dependence on a specific platform to access data stored on IPFS, which is crucial for true user autonomy. By providing an open source tool for downloading files from IPFS, we reduce friction and allow users to regain control of their data in the event of service interruption or platform change.

The main benefit is to strengthen user confidence in decentralized storage. The risk of not completing this project is to limit the adoption of Hashguard and, more broadly, decentralized storage, due to concerns about the long-term access to data.

This project will have a direct impact on Hashguard users, allowing them to retrieve their encrypted files independently. The success of this project will be measured by the number of users who download their files via this open source site and by the quality of the code and documentation, encouraging the community to contribute and maintain the project over the long term. Success is also measured by the ease of use of the site and its ability to work with all types of files supported by Hashguard.

Outcomes

The final outcome of this project will be a functional and well-documented open source website, allowing users to easily download their files from IPFS.

Project Specifications:

  • Intuitive User Interface: The website should be easy to use, even for non-technical users.
  • CID Support: The site should allow users to enter the CID of their files to download them.
  • Encryption Key Management: The site should potentially include a section, or point to third-party open source tools, allowing users to enter their encryption keys to decrypt the downloaded files (if necessary, depending on the encryption implementation at Hashguard).
  • Direct Download: The site should allow direct download of files from IPFS.
  • Browser Compatibility: The site should be compatible with modern web browsers (Chrome, Firefox, Safari, etc.).
  • Responsive Design: The site should be responsive and adapt to different screen sizes (desktops, tablets, smartphones).
  • Documentation: The site should be accompanied by clear and concise documentation for users and developers.
  • Open Source: All source code will be published under a MIT/Apache-2 dual-license.

Success Metrics:

  • Number of Downloads: We will track the number of file downloads via the website.
  • Usage Rate: We will measure the usage rate of the website by Hashguard users.
  • Open Source Contributions: We will track the number of contributions (pull requests, issues) to the project codebase.
  • User Satisfaction: We will collect user feedback on the ease of use and functionality of the website.
  • Site Performance: We will track the website's response times and ensure it is fast and reliable.

Adoption, Reach, and Growth Strategies

The target audience for this project consists mainly of current and former Hashguard users, approximately [estimate number of users]. We are currently engaging them through our application, our customer support channels, and our social media.

Adoption Strategy:

  • Announcement on the Hashguard Platform: We will announce the launch of the open source website on our platform and through our communication channels.
  • Clear Documentation: We will provide clear and concise documentation on how to use the website.
  • Integration (if possible): We will explore the possibility of integrating a direct link to the retrieval site in the Hashguard application to facilitate access.
  • Filecoin and IPFS Community: We will present the project to the Filecoin and IPFS community, highlighting its contribution to the accessibility of decentralized data.
  • SEO: Optimize the site for search engines, to help users easily find it when searching for a solution to download files from IPFS.

Onboarding:

  • First 10 Users: We will identify a group of 10 Hashguard users and invite them to test the website in preview, asking them to provide feedback.
  • First 100 Users: We will launch a targeted communication campaign on our social media and via email to encourage users to try the website. We will offer personalized support to the first 100 users to answer their questions and resolve any issues.

Development Roadmap

Milestone 1: Infrastructure and Basic Interface (2 weeks)

  • Functionality:
  • Set up the website's basic infrastructure (framework, hosting, etc.).
  • Create a simple user interface allowing the user to enter a CID.
  • Implement basic download functionality from IPFS.
  • Personnel: 1 full-stack developer, 1 designer (part-time).
  • Completion Date: [Date in two weeks]

Milestone 2: Interface Improvement and Encryption Management (3 weeks)

  • Functionality:
  • Improve the user interface (design, ergonomics, responsiveness).
  • Implement encryption key management (if necessary, depending on the implementation at Hashguard) or link to open source tools.
  • Add error management and user feedback features.
  • Personnel: 1 full-stack developer, 1 designer (part-time).
  • Completion Date: [Date in 5 weeks]

Milestone 3: Testing, Documentation, and Publication (2 weeks)

  • Functionality:
  • Thoroughly test the website.
  • Create comprehensive documentation for users and developers.
  • Publish the open source website on GitHub.
  • Personnel: 1 full-stack developer, 1 technical writer (part-time).
  • Completion Date: [Date in 7 weeks]

Total Budget Requested

| Milestone # | Description | Deliverables | Completion Date |
|1|Infrastructure and Basic Interface|Website with basic interface and download functionality|[Date in two weeks]|
|2|Interface Improvement and Encryption Management|Improved user interface, encryption key management (or link to open source tools)|[Date in 5 weeks]|
|3|Testing, Documentation, and Publication|Tested and documented website, source code published on GitHub|[Date in 7 weeks]|

What is the total amount of this grant request?

$10K

Maintenance and Upgrade Plans

We are committed to maintaining and improving this project over the long term. Our plan includes:

  • Monitoring Bugs and Vulnerabilities: We will actively monitor the website to detect and fix bugs and security vulnerabilities.
  • Regular Updates: We will publish regular updates to improve the functionality, performance, and security of the website.
  • Community Support: We will respond to questions and support requests from the community.
  • Project Evolution: We will consider feature requests and contributions from the community to evolve the project based on user needs.
  • Adoption of New Technologies: We will stay abreast of new technologies and trends in the field of decentralized storage and integrate them into the project if relevant.

Team

Team Members

  • Antoine Servant
  • Lilyan Bastien
  • Steeve Dumont

Team Member LinkedIn Profiles

Team Website

https://hashguard.io/

Relevant Experience

Our team has significant experience in web application development, decentralized storage, and blockchain. We have already developed and deployed the Hashguard application, which uses IPFS and Filecoin for storing encrypted files. We also have a strong track record in creating intuitive user interfaces and documenting open source projects. We are passionate about democratizing decentralized storage and are confident that we are the ideal team to carry out this project.

Team code repositories

app: https://hashguard.xyz/

Additional Information

We learned about the Open Grants program via Julien Noel
lilyanb@hashguard.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants