https://github.com/benjifs/sparkles

a micropub client
https://github.com/benjifs/sparkles

indieweb micropub

Last synced: about 2 months ago
JSON representation

a micropub client

• Host: GitHub
• URL: https://github.com/benjifs/sparkles
• Owner: benjifs
• License: mit
• Created: 2022-12-08T16:00:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T21:01:31.000Z (3 months ago)
• Last Synced: 2024-10-26T08:27:15.472Z (3 months ago)
• Topics: indieweb, micropub
• Language: JavaScript
• Homepage: https://sparkles.sploot.com
• Size: 763 KB
• Stars: 22
• Watchers: 1
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# sparkles



  





  

    

  





  

  

  



[sparkles](https://sparkles.sploot.com) is a [Micropub](https://micropub.spec.indieweb.org/) client. It supports [IndieAuth](https://indieauth.net/) for login and expects a [micropub endpoint](https://indieweb.org/Micropub/Servers) to communicate with to publish posts. It supports basic micropub content types, as well as the following experimental post types:

- movie ([watch](https://indieweb.org/watch))

- book ([read](https://indieweb.org/read))

- music ([listen](https://indieweb.org/listen))

- game ([play](https://indieweb.org/play))

sparkles can also be installed as a [Progressive Web App (PWA)](https://web.dev/progressive-web-apps/) 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](https://benji.dog/articles/sparkles/) 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](https://developer.themoviedb.org/) for movie search |

| `GIANTBOMB_API_KEY` | [GiantBomb API Key](https://www.giantbomb.com/api/) 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](https://indieweb.org/Micropub/Servers) with an `access_token`.