1. Contributing Guide
  2. MindsDB Installation for Development

If you want to contribute to the development of MindsDB, you need to install it first.

There are a few installation options that you can choose as follows:

Our preferred MindsDB installation method for development is the installation from source.

Installing MindsDB

Here, we recall the steps of MindsDB installation from source. You can either follow the steps below or visit the provided link.

Before proceeding, make sure you have Git and Python 3.7.x or Python 3.8.x installed.

  1. Fork the MindsDB repository from GitHub.

  2. Clone the fork locally:

git clone git@github.com:YOUR_USERNAME/mindsdb.git
  1. Create a new virtual environment:
python -m venv mindsdb-venv
  1. Activate the virtual environment:
source mindsdb-venv/bin/activate
  1. Install dependencies:
cd mindsdb & pip install -r requirements.txt
  1. Install MindsDB:
python setup.py develop
  1. Start MindsDB:
python -m mindsdb

If everything works as expected, you should see the following message in the console:

...

2022-06-28 16:21:46,942 - INFO - - GUI available at http://127.0.0.1:47334/
2022-06-28 16:21:47,010 - INFO - Starting MindsDB Mysql proxy server on
tcp://127.0.0.1:47335 2022-06-28 16:21:47,015 - INFO - Waiting for incoming
connections... mysql API: started on 47335 http API: started on 47334

What’s Next?

Now that you are all set, we recommend you check out our Tutorials and Community Tutorials sections, where you’ll find various examples of regression, classification, and time series predictions with MindsDB.

To learn more about MindsDB itself, follow the guide on MindsDB database structure. Also, don’t miss out on the remaining pages from the SQL API section, as they explain a common SQL syntax with examples.

Have fun!