filecoin-project / devgrants

👟 Apply for a Filecoin devgrant. Help build the Filecoin ecosystem!
Other
375 stars 308 forks source link

FVMFlow: Analytics Dashboard for Exploring Activities in FVM #1509

Closed justmert closed 1 year ago

justmert commented 1 year ago

Open Grant Proposal: FVMFlow

Name of Project: FVMFlow

Proposal Category: app-dev

Proposer: justmert

(Optional) Technical Sponsor: No

Do you agree to open source all work you do on behalf of this RFP and dual-license under MIT or APACHE2 licenses?: Yes

Project Description

As the Filecoin FVM ecosystem continues to grow, it's becoming increasingly challenging to stay informed about the ecosystem's status and trends, as well as the activities of the many open-source projects being built on or integrated with the FVM environment. With data scattered across various platforms through Github to Twitter, gaining a comprehensive view of the ecosystem can be a daunting task.

FVMFlow offers a cutting-edge solution to this problem, providing a comprehensive platform that delivers various insights and metrics to track the activities and development of the Filecoin FVM ecosystem. Through intuitive and interactive visualizations and charts, FVMFlow empowers users to gain a clear understanding of code contributions, community engagements, trend data, and many other critical metrics related to the Filecoin FVM ecosystem.

By tracking various off-chain sources, FVMFlow is the go-to platform for gaining a comprehensive view of the Filecoin FVM and becomes uniqueness in the space.

Links

Value

Deliverables

The final deliverable of FVMFlow will be a comprehensive analytics dashboard that provides detailed insights and visualizations into activity of FVM ecosystem projects. FVMFlow will be comprised of the following functionality and features:

Website

Dashboard Page Project List Page Project Page
Screenshot 2023-04-03 at 15-31-34 FVMFlow Screenshot 2023-04-03 at 15-47-55 Projects Screenshot 2023-04-03 at 15-32-01 Project Page

Technical Scheme

fvmflow_technical_scheme

Development Roadmap

Milestone 1

Number Deliverable Specification
0. License Add an MIT License to both the backend and frontend Github repositories of FVMFlow.
1. Database Set up a Firebase project and Firestore database to store chart data and project metadata.
2. Backend To integrate Github Data to the FVMFlow, develop a Python backend that uses both the Github Rest and GraphQL APIs to fetch latest data from the Github.
3. Frontend Build the Project Detail and Dashboard pages, including the following implementations: Commit History By Weeks, Code Frequency, Top Contributors, Issue Activity, Issue Count, Star Count, Pull Request Count, Recent Issues, Recent Commits, Pull Request Activity, Recent Stargazing Activity.
4. Frontend Develop a Project List page that lists all Filecoin FVM ecosystem projects in order of their respective stargazing counts.
5. Integration Integrate Algolia to improve the search functionality of the platform.
6. Integration Integrate Typeform to allow ecosystem users to suggest new projects for the platform.
7. Integration Integrate Google Analytics to track user engagement and improve the platform accordingly.
8. Backend Set up a regular update schedule for the backend to keep the database up-to-date with the latest data.

Milestone 2

Number Deliverable Specification
1. Feature Integrate Twitter data of Filecoin FVM and its associated projects into the platform, including metrics such as the number of tweets posted per day or week, the number of likes, retweets, and replies received, and other relevant analytics.
2. Feature Develop categorization feature to classify projects based on various criteria within the FVMFlow, such as DeFi, DEX. The feature will make it easier for users to find projects that are of interest to them.
3. Feature Develop project health score feature that evaluates multiple metrics to provide users with an overview of a project's health. The score helps identify promising projects and high-risk ones. The resulting score, weighted by metric importance, will display on the project detail page.
4. Feature Develop an API for FVMFlow that provides developers with access to FVMFlow charts and metadata. The API will use RESTful architecture and documented using OpenAPI Specification. Using the API, developers can embed charts and data into their own applications.
5. Feature Up-to-date ecosystem project list on FVMFlow will be customized based on the protocol's preference. If the protocol wishes project list to be updated independently, a GitHub crawler will be implemented to automatically discover ecosystem projects and adds them to the FVMFlow. Alternatively, if the protocol has a project list available on a platform such as Notion, we will use the platform's respective API to access the list. In addition, if the protocol has a website that displays its ecosystem projects, such as an awesome list or other third-party application, we can parse the GitHub links and incorporate them into FVMFlow. We will collaborate with the protocol to determine the most effective approach and ensure the project list is kept up-to-date and accurate.

Total Budget Requested

Total Funding Requested: $28,000

The funds for FVMFlow will be allocated towards maintaining and improving the platform in various ways. The majority of the budget will go towards the development, for maintaining and updating the platform. A significant portion of the budget will be allocated towards infrastructure costs, including server hosting, database management, and other necessary tools and services. By using the funds in these areas, I ensure that the application and its associated services are maintained and improved over time.

Maintenance and Upgrade Plans

To ensure FVMFlow remains up-to-date and meets the needs of ecosystem users, we plan to implement the following maintenance and upgrade plans:

Team

Team Members

Mert Köklü

Relevant Experience

As an experienced Web3 developer, I have become a grantee for Web3 Foundation, AAVE, Lens and Filecoin ecosystems by developing innovative projects. As a certified NVIDIA instructor, AAVE Turkey Community Co-Manager and ambassador for organizations such as Microsoft and The Graph protocol, I have become a trusted voice within the communities and gained a deep understanding of their needs and requirements.

Currently, I'm focused on developing open-source and user-friendly applications that bring value to the FVM ecosystem.

Team code repositories

Additional Information

I have learned about the Open Grants Program from the Filecoin Dev Grants page.

justmert commented 1 year ago

Hi @realChainLife , @eshon, @ErinOCon! Is there any update? Also could you tag the proposal with 'FVM'. Thanks and looking forward a review.

ErinOCon commented 1 year ago

Hi @justmert, thank you for your proposal! We are behind schedule for our April submissions, but expect to have an update available in the next couple weeks. Thank you for your patience!

justmert commented 1 year ago

Eagerly waiting for your review! Thank you @ErinOCon.

ErinOCon commented 1 year ago

HI @justmert, thank you for your patience with our review. Unfortunately, we will not be moving forward with a grant at this time. Wishing you all the best as you continue building!

justmert commented 1 year ago

Hey, thanks for the response!