Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 3.31 KB

README.md

File metadata and controls

79 lines (46 loc) · 3.31 KB
Raw

SEC Edgar database analyser

This is a combined archive which houses all the submodules of project.

image

version license contributors stars fork

UPDATE (Mar 2022)

v3.0: Develop multi-compare and charts.

v3.1: Predict investability score (95% similarity with Zachs rank).

v2.1: Decided to use regression boosting (XGboost) for predicting company score.

v2.0: Decided to use GraphQl for backend services to limit endpoints.

UPDATE (Feb 2022)

v1.2: Develop web scraping tool for Extracting and transforming data.

v1.2: Use firebase NoSQL to store the model data.

v1.1: Decided on financial metrics to use. EBIDTA, ROI, Magic number, Customer Acquision Cost ...

v1.0: Build user interface on React and viteJs.

Architecture

image

Investability score

image

In a overview of the investability score prediction

image

Libraries/Code sources

Except for the ReChart and Tailwind CSS library for frontend most functionality is written in Vanilla-Js and React-Js. Python toolkit is created using beautiful soup and sklearn library.

Some icon images have been sourced from Font Awesome 5. The license is at this link. No changes (except scaling) were made to these images.

References

Links to original repositories are

  1. https://github.com/Web-Team-IITI-Gymkhana/data-bot
  2. https://github.com/Web-Team-IITI-Gymkhana/saas-client
  3. https://github.com/Web-Team-IITI-Gymkhana/saas-server

Technical details

Each submodule has its own defined technology specification as a README.md file.

Contribute

First of all, thanks for your contribution! Every small bit of it counts! You can:

  1. Create a new issue for bugs, feature requests, and enhancements.
  2. Fork the repo, make changes, and submit a pull request, describing the changes made.
  3. We would love to get to know more financial metrics and optimization techniques to explore.
  4. Finally, utilize the Filing analyser for understanding the SAAS market and curating your portfolio!
  5. Do star the repo if you like it!

Development

To setup the user interface repo, clone it, cd into it, and then run npm install. To start the server npm run dev.
To setup the data-scraping repo. Create a firebase account. Clone the repo, cd into it, and then run webscrape.py.

Contact us - krishanu21saini@gmail.com - to discuss anything related to the above if you want to.