GitHub badge

Azimutt can load any SQL file from the URL and display its entity-relationship diagram. Thanks to that, you can create a GitHub badge allowing your users to explore your database schema, IN ONE CLICK 🤯

Just try it:

To use it on your own repository, there are a few simple steps:

1. Navigate to your SQL schema file and get it's *raw* url

   For Azimutt the file is backend/priv/repo/structure.sql, so the raw url is:
   https://raw.githubusercontent.com/azimuttapp/azimutt/refs/heads/main/backend/priv/repo/structure.sql

2. Build the Azimutt create url

   The format is https://azimutt.app/create?sql=$url&name=$project_name, so for Azimutt it's:
   https://azimutt.app/create?sql=https://raw.githubusercontent.com/azimuttapp/azimutt/refs/heads/main/backend/priv/repo/structure.sql&name=Azimutt

3. Create your badge with shields.io

   You can build the one you want. For PostgreSQL here what we suggest:
   https://img.shields.io/badge/PostgreSQL-browse_online-gray?labelColor=4169E1&logo=postgresql&logoColor=fff&style=flat
   See below for others.

4. Put everything together, displaying a link with image in your README

   In Markdown it's: [![Image alt](Image url)](Link url), so the final result for Azimutt is:
   [](https://azimutt.app/create?sql=https://raw.githubusercontent.com/azimuttapp/azimutt/refs/heads/main/backend/priv/repo/structure.sql&name=Azimutt)

Depending on your database, you can use these examples:

Some repos have adopted it, add yours if you want:

• azimuttapp/azimutt