Skip to content

README.md

Latest commit

 

History

History
54 lines (36 loc) · 1.02 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.02 KB

API

Personal API for my projects and services. Built with Go and a Node.js for the Open Graph . It provides small utility endpoints and integrations used across my projects.

Features

Currently available features/endpoints:

  • Open Graph image generation (OG images).
  • Spotify endpoints (currently-playing, top tracks, etc.).
  • Jellyfin endpoints (media status).
  • Tools endpoints (headers, IP info, etc.).
  • Real-time updates for Spotify and Jellyfin via Server-Sent Events (SSE).

Development

Steps to run the project locally:

  1. Clone the repository

    git clone https://github.com/ccrsxx/api

  2. Change directory to the project

    cd api

  3. Install dependencies

    go mod download

  4. Install Tools

    make setup-tools

  5. Set up environment variables Create a copy of the .env.example file and name it .env. Fill in credentials as needed.

    cp .env.example .env

  6. Run the app in development

    make dev