Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.64 KB

README.md

File metadata and controls

30 lines (24 loc) · 1.64 KB

Square Log

Welcome to square-log, your nifty tool for collecting and tracking all your cherished activities from across the web. Think of it as the Github contributor's activity log, but with a twist. The aim is to offer a versatile backend that captures personal daily digital footprints from various sources

Plugins

square-log uses Lua scripting for flexibility and ease of use. With this, you can easily gather data from your blog, GitHub, or other places where you leave your digital footprint. It's designed to be adaptable to different needs.

Storage

square-log is supposed to be run on your personal computer and act as an invisible ghost writer of your daily online activity. The data is stored in a simple but convenient Sled database.

HTTP API

What you do with the collected data is your choice. A common use could be to display it on your personal blog. To help with this, I'm working on a simple js library. Keep in mind, square-log is meant for personal use.

Running

To run the project:

cargo run -- --config config.yaml

Development

Right now, square-log is in its early stages. It will be an essential part of my personal website, so I'm dedicating time to develop it further.

As of now, these are the short term tasks to be done:

  • - Scaffold mlua integration
  • - Minimal plugin api definition
  • - Sled database integration
  • - Scheduler for pull tasks
  • - Http API
  • - Pull checkpoint persistence (lastest record)
  • - Github Lua plugin
  • - JS library