We welcome all contributions to Mage; from small UI enhancements to brand new cleaning actions. We love seeing community members level up and give people power-ups!

Got questions? Live chat with us in Slack

Anything you contribute, the Mage team and community will maintain. We’re in it together!

1. Set up development environment
2. Debugging
3. Guides

First, create a new project:

$ ./scripts/init.sh [project_name]

Run the below script to build the Docker image and run all the services:

$ ./scripts/dev.sh [project]

Instead of using breakpoint(), add the following line to your code where you want a debug:

import pdb; pdb.set_trace()

Attach to running container to use debugger. To get the container ID, run docker ps and look in the NAMES column.

$ docker attach [container_id]

Code for the web server is in mage_ai/server/.

Code for the front-end app is in mage_ai/frontend/.

1. How to add a new chart type