README.md

Open-source Company Database: For Data-driven Deal Sourcing

Overview

A ready to use open-source company database integrated with BI tool for sales and investment intelligence.

⚡ Getting Started

The easiest way to run Open Company Database is inside a Docker container. It works best with the most recent version of Docker, 26.0.0. You must be using Linux, Mac OS, or WSL on Windows.

docker compose up

For the first time, it takes about 2-3 minutes for all 3 containers to come up.

To interact with the sample database, login into Metabase running on http://localhost:3000/ via

• Email: admin@opencompaniesdb.local
• Password: OpenCompanyDatabase@1

📊 Enriching company database via Crustdata API

• Request Crustdata API for free from https://crustdata.com
• Set CRUSTDATA_API_TOKEN inside settings.py
• By referring to the API documentation, update the filter criteria in crustdata_request_payload.json for companies to be fetched and enriched.
• Run docker-compose --profile enrich up enrich_via_crustdata .

🛠️ Installation and Development

Open Company Database is a community-driven project, and we welcome contributions from everyone. Whether you're a data engineer who's setting up the company data stack or an AI engineer who wants to leverage company firmographic and growth data to create your agents, there are many ways to get involved:

• Fix bugs
• Code contributions
• Feedback and testing

For details, please check INSTALLATION.md.

License

This project is licensed under the MIT License. See the LICENSE file for details.