RizzDocs is a project designed to centralize learning resources for developers and projects in need of documentation. This README provides essential information for setting up and understanding the project.
To see RizzDocs in action, check out our demo video:
This video provides a visual demonstration of how the project works.
Before you begin working with the project, ensure you follow these steps:
-
Install Dependencies
To work on this project using an Apple M1 processor, run the following command:
npm install sqlite3 --build-from-source --target_arch=arm64 --fallback-to-build
Alternatively, if you encounter issues, you can delete the lockfile and work on other aspects of the project.
This section lists relevant Solidity contracts and their associated addresses on the Filecoin Test Net FVM (Filecoin Virtual Machine).
-
RIZZDOCSTOKEN: Contract Address:
0x3E315dA04D7BFFC60706fbc9b32ac7113B4FaCb4 -
TIMELOCK: Contract Address:
0x220c35FAF60c2D9A503b2129d484aE6d3e0409A7 -
GOVERNORCONTRACT: Contract Address:
0xaB5A53c71b5AA89D3Bf414d31d5F7c49aD847a11 -
RIZZDOCSCLIENT: Contract Address:
0x6Ae27761Dc118d367307C318aF75B98E21C37A6d -
RIZZDOCSCLIENT (Duplicate): Contract Address:
0x599600F39C880F699440FFD7baB0C0dfE2c57f6A -
RIZZDOCSDOC: Contract Address:
0x91Ac9e90D9Ccb2E3BfDC2b15383CAb212eBD5411
These contracts play a vital role in the functionality of RizzDocs.
The hexadecimal addresses listed above correspond to relevant Solidity contracts on the Filecoin Test Net FVM. Ensure that you use the appropriate addresses and contracts when interacting with the project.
Feel free to explore and contribute to this exciting initiative that aims to make learning resources accessible and centralized for developers and projects. For any questions or clarifications, please dm me on twitter @kelvinpraises