michivonah/projects-api repository overview

⁠projects-api

A simple API which combines projects from a Ghost Blog, a YouTube Playlist and a generic JSON file into it's own streamlined interface. Built with go.

⁠Features

• Built with go for efficiency & simplicity
• Runs in a container of just 9 MiB size
• Combines multiple API outputs into one (Ghost, YouTube & generic JSON)
• 0 external dependencies, just the go standard library

⁠Available API integrations

• Ghost Content API
• YouTube Data API v3
• Generic JSON URL (example format seen below)

⁠Generic JSON URL Format

• The URL specified for the generic JSON URL should return projects using this pattern/format:

[
    {
        "url": "https://example.com",
        "image": "https://example.com/some-image.webp",
        "title": "Some project title",
        "date": "2024-11-03T00:00:00Z",
        "category": "some-category",
        "icon": "some-icon-name"
    },
    {
        "url": "https://example.com",
        "image": "https://example.com/some-image.webp",
        "title": "Some project title",
        "date": "2024-11-03T00:00:00Z",
        "category": "some-category",
        "icon": "some-icon-name"
    },
    {
        "url": "https://example.com",
        "image": "https://example.com/some-image.webp",
        "title": "Some project title",
        "date": "2024-11-03T00:00:00Z",
        "category": "some-category",
        "icon": "some-icon-name"
    }
]

⁠Configuration

• The appliaction can be configured via env vars or an .env file in the execution directory
• The follwing parameters are available

• If you want to use one of the available API integrations, you have to pass all related env vars for this service. It's possible to skip entire services be leaving it's variables empty.
• For example you can disable the Ghost API by leaving GHOST_API_KEY, GHOST_API_URL and/or GHOST_ALLOWED_AUTHORS empty. The call's to the Ghost API only are enabled if all of those three variables are defined. The same principal applies to the YouTube & JSON API.

⁠Build

To build the software yourself you need go installed on your system.

Then build like this:

go build -o projects-api .

And run it locally:

projects-api

⁠Deploy yourself via Docker/Podman/OCI

By passing variables

docker run --rm -p 8080:8080 --env ALLOWED_ORIGINS=http://localhost,http://localhost:8080 --env GENERIC_JSON_URL=https://example.com/projects.json -d docker.io/michivonah/projects-api:dev

Docker compose:

services:
    projects-api:
        ports:
            - 8080:8080
        environment:
            - ALLOWED_ORIGINS=http://localhost,http://localhost:8080
            - GENERIC_JSON_URL=https://example.com/projects.json
        image: docker.io/michivonah/projects-api:dev

With env file

docker run --rm -p 8080:8080 -v ./.env:/app/.env -d projects-api