https://github.com/bacv/square-log
A nifty tool for collecting and tracking all your cherished activities from across the web
https://github.com/bacv/square-log
lua rest rust scraping
Last synced: 6 months ago
JSON representation
A nifty tool for collecting and tracking all your cherished activities from across the web
- Host: GitHub
- URL: https://github.com/bacv/square-log
- Owner: bacv
- License: mit
- Created: 2024-01-16T19:42:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T20:43:43.000Z (about 2 years ago)
- Last Synced: 2025-03-22T21:42:10.454Z (about 1 year ago)
- Topics: lua, rest, rust, scraping
- Language: Rust
- Homepage:
- Size: 86.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/spacejam/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:
```bash
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](https://github.com/bacv/inkagu-co), so I'm dedicating time to develop it further.
As of now, these are the short term tasks to be done:
- [x] - Scaffold `mlua` integration
- [x] - Minimal plugin api definition
- [x] - `Sled` database integration
- [x] - Scheduler for pull tasks
- [x] - Http API
- [x] - ~~Pull checkpoint persistence~~ (lastest record)
- [x] - Github Lua plugin
- [ ] - JS library