Process of Score calculation
Product Flow on Our Internal Content Management System (CMS):
Accessing Our CMS: Visitors start by navigating to our internal Content Management System (CMS) platform, where they can initiate the Scoutflo Health Score evaluation process. Here, they enter the GitHub link of their organization to validate it.
Data Validation and Manual Input: Upon validation, CMS APIs fetch necessary data. Users then complete the manual fields in the Product section, including social links, communication details, investment specifics, roadmap links, and pricing information.
Transition to the Technology Section: After filling in the mandatory score-related fields and meeting validation conditions, users click "Next" to transition to the Technology section. Here, they choose repositories for scoring and other purposes. A dedicated section for Scoutflo Health Score differentiates the selected repo.
Backend Operations - Storing Manual Data: As users move forward, all manual data entered is sent to our APIs, which store it in the database. This data primarily contributes to the evaluation of Community Activeness and Business metrics.
GitHub and OpenSSF API Integration: Simultaneously, selected repositories trigger GitHub and OpenSSF APIs in the backend. GitHub APIs fetch various data points, while OpenSSF APIs provide final scores. These data points and scores are stored in the database.
Data Fetching in the Community Section: On the Community page, users fetch data from external APIs. Upon clicking "Next," this data, along with OpenSSF scores, undergoes calculation to generate final scores for the remaining two metrics.
Frontend Health Score Display: Users proceed to the Health Score section, where scores are displayed. A loading state is shown until backend calculations are complete. Scores are fetched from the database as soon as they are ready.
Score Validation and Publication: Users can thoroughly check each metric and element score. If satisfied, they activate the score and publish the product along with the Scoutflo Health Score.
Backend Flow:
Storing Manual Data: When users fill in data on the Product page, our APIs store this manual data in the database for evaluating Community Activeness and Business metrics.
GitHub and OpenSSF API Integration: As users proceed, selected repositories trigger GitHub and OpenSSF APIs in the backend. GitHub APIs fetch data points, and OpenSSF APIs provide scores, all stored in the database.
Fetching and Calculating Final Scores: A GET API fetches data points and scores, running them through our formulas for the remaining two metrics. Final scores for all metrics and elements are calculated and stored in the database.
This detailed process ensures a comprehensive evaluation of open-source products through Scoutflo Health Score.
Note: The current CMS flow is exclusively for internal team management. We plan to extend access to product founders in the near future, allowing them to seamlessly engage with the CMS workflow and leverage the power of Scoutflo Health Score for their open-source products. Stay tuned for updates on expanded access!
Last updated
