Run Project button

Clicking the Run Project button (or azk button) on a GitHub repo is the best way to quickly and safely run its code on your local machine.

Run project

To add a Run Project button to a repo, you'll just need to add an Azkfile.js to the project and put the following badge in your file (the following example is for a hypothetical repository with the URL and a branch called azkfile containing the Azkfile.js):

[![Run project](](

Check out the Run Project Gallery for examples of up-to-date forks of popular projects using it. If you want to suggest a new project for the gallery, feel free to open an issue or send us a pull request with your project (on the gallery repo on both cases).