DCellar Open Source Developer Guide

Overview

DCellar is an open-source project implementing a development management console built on the BNB Greenfield decentralized storage network, aiming to empower developers to quickly get started with decentralized storage and assist in the development process and team collaboration.

Why DCellar?

Get started with BNB Greenfield at ease.
Give you a quick look at the various scenarios and underlying capabilities supported by BNB Greenfield through visualization. DCellar has a visualized UI that aids you with the quick development process and teamwork.
Use a user-friendly interface to store, share, and manage your data.
Permission and group management in an easy way for sharing and collaboration. You can reuse the storage management module directly in your project.
Comprehensive data dashboard.
A clearer picture of the current storage bandwidth, download quota, objects, etc. If you are going to calculate the Greenfield-related data, you can use the dashboard chart in your project very soon.
Best practice for Greenfield's latest feature.
DCellar is always up to date with the newest technology which you can leverage the best user experience and latest features.

Key Features

Module	Description
Data Dashboard	A comprehensive data dashboard displays storage usage, cost usage, and other relevant metrics.
Storage Management	DCellar's visual storage management feature enables you to easily store, download, share, and perform batch operations on objects.
Permission Management	Manage access to the buckets and objects you create, whether for groups or individuals.
Accounts Management	Users can create multiple payment accounts and have permission to link buckets to different payment accounts to pay for storage and data packages.
Cross-chain Assets Management	Cross-chain assets management enables the transfer of assets between BNB Greenfield and BNB Smart Chain (BSC).

How to Get Started

Clone the repository:
git clone [email protected]:node-real/dcellar.git
Install the Rush tool as a global package:
npm install -g @microsoft/rush
Install dependency and build symbolic links for apps:
rush install

Check the DCellar's README file for instructions on installing dependencies.

Using the Project

Installation: Follow the installation instructions provided in the DCellar's README file.
Integration: Integrate the DCellar into your existing application or development environment.
Customization: Customize the DCellar to meet your specific requirements or use case.
Feedback: Provide feedback on your experience using the DCellar and report any issues or bugs encountered.

Communication Channels

GitHub Issues: Use GitHub issues to report bugs, request features, or discuss enhancements.
Pull Request Discussions: Engage in discussions within pull requests to address concerns or clarify implementation details.

Additional Resources

Project Github: Check the DCellar's github for additional documentation and guidelines.
Contributor Guidelines: Refer to the DCellar's contributor guidelines for specific instructions on contributing.
License: Make sure you understand and comply with the DCellar's licensing terms.

Thank You

Thank you for considering using and contributing to DCellar! We welcome developers to utilize our open-source codebase and encourage collaboration to improve and extend its functionality. If you have any questions, feel free to reach out to us for assistance. Happy coding!

Disclaimer

The software and related documentation are under active development, all subject to potential future change without notification and not ready for production use. The code and security audit has not been fully completed and are not ready for any bug bounty. We advise you to be careful and experiment on the network at your own risk. Stay safe out there.