Skip to content

benjifs/sparkles

Repository files navigation

sparkles

sparkles icon

Project License Latest Version Latest Commit

sparkles is a Micropub client. It supports IndieAuth for login and expects a micropub endpoint to communicate with to publish posts. It supports basic micropub content types, as well as the following experimental post types:

sparkles can also be installed as a Progressive Web App (PWA) on supported devices which will add the app as a share target and also add some quick action options.

You can read more about this project here and try it for yourself at: https://sparkles.sploot.com

Development

Requirements

  • node 18.12.1
  • npm >=8.19.2
  • npm install -g netlify-cli

Environment Variables

name description
TMDB_API_KEY TMDB API Key for movie search
GIANTBOMB_API_KEY GiantBomb API Key for video game search

Build

  • Clone this repository
  • npm install
  • Run netlify dev to test locally
    • Your default browser should automatically open to: http://localhost:8888
    • The frontend will run on port 5173
    • The functions will run on port 5174

While running in DEV mode, the login screen will allow you to either go through the standard authentication process OR add a test micropub endpoint with an access_token.