Portal

Create simple landing / profile page.

How to Use

GitHub

Add portal.json to repository username/username.

The content of portal.json should be like this:

{
    "background": "https://storage.jacoblin.cool/unicourse-bg.png",
    "blocks": [
        {
            "block": "head",
            "permission": 0,
            "display": "Jacob Lin",
            "avatar": "https://storage.jacoblin.cool/avatar.jpg"
        },
        {
            "block": "chat",
            "permission": 0,
            "greeting": "👋 嗨！我是林振可（Jacob Lin），目前就讀於師大資工\n我喜歡設計些有趣的程式 🎨"
        },
        {
            "block": "action",
            "title": "你可以在這些地方找到我～",
            "permission": 0,
            "actions": [
                {
                    "display": {
                        "icon": "mdi:github",
                        "text": "GitHub",
                        "color": ""
                    },
                    "handle": {
                        "type": "link",
                        "value": "https://github.com/JacobLinCool"
                    }
                },
                {
                    "display": {
                        "icon": "mdi:linkedin",
                        "text": "LinkedIn",
                        "color": "210 90% 40%"
                    },
                    "handle": {
                        "type": "link",
                        "value": "https://www.linkedin.com/in/jacoblincool/"
                    }
                },
                {
                    "display": {
                        "icon": "carbon:logo-discord",
                        "text": "Discord",
                        "color": "235 86% 65%"
                    },
                    "handle": {
                        "type": "link",
                        "value": "https://discord.gg/Ff8q2SGut2"
                    }
                }
            ]
        }
    ]
}

You can see my portal.json for more details.

Then, visit https://ptl.pages.dev/gh/username. (Or https://portal.csie.cool/gh/username)

Supported Blocks

• head - Display user's avatar and name.
• chat - PortalGPT chatroom.
• action - Display links.
• carousel - Display auto-sliding images (with links).
• iframe - Display iframe.
• code - Display a code block.
• Waiting for your suggestion!

Webhook

To receive the event when user visit your portal or do interaction, you can use webhook.

{
    "webhooks": [
        "https://example.com/my-webhook",
        "https://discord.com/api/webhooks/your/discord-webhook"
    ]
}

The events are directly sent by the client, so you should check the validity by yourself to prevent abuse. The client-side doesn't care about the response status of the webhook, CORS is not needed.

The payload of the event is like this:

{
    "on": "https://portal.csie.cool/gh/JacobLinCool",
    "event": "visit",
    "data": {
        "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36"
    },
    "visitor": 15263748
}

Discord webhooks have a special format to display the message in channels.