Mage
Search…
⌃K

Contributing

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!

Projects to contribute to

If you’re looking for cool projects to ship, check out the following:
Small to medium complexity projects
Roadmap
Small to large complexity projects

Set up development environment

  1. 1.
    Create a new project:
    ./scripts/init.sh [project_name]
  2. 2.
    Run the below script to build the Docker image and run all the services:
    ./scripts/dev.sh [project]
  3. 3.
    Open your browser and go to http://localhost:3000.

Debugging

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]

Backend server

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

Front-end app

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

Guides

  1. 2.
    More coming soon...

Testing changes

Please read this document.