Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emptymalei/social-pulse

my social pulse
https://github.com/emptymalei/social-pulse

Last synced: 12 days ago
JSON representation

my social pulse

Awesome Lists containing this project

README

        

# social-pulse

Automated collection of social activities using GitHub Actions.

[Demo](https://pulse.leima.is/)
![](assets/demo.png)

## How it works?

There are two components in this repo

1. Data collection: the python code in `pulse` folder will be executed regularly using cronjob in GitHub Actions.
2. Dashboard: the frontend code in `dashboard` folder takes the data and visualizes it.

## How to set up your own pulse?

Fork the repo, and change the configs.

1. Fork the repo. Make sure to allow GitHub Actions when forking.
2. Remove the data files in `dashboard/data`.
3. Change the `CNAME` file to adjust to your own domain name if needed. Otherwise, delete the file.
3. Change the configs (see below).

### Change the Configs

The config file is located in `configs/config.json`.

Change all the `user_id` fields in the config. Check the details of the `//` comments in the following example.

```
{
"name": "social pulse",
"base_folder": "dashboard/data",
"enabled": [
["douban", "book_movie_music"]
],
"combined": {
"artifacts": {
"local": "pulses.json"
}
},
"social": {
"douban": {
"book_movie_music": {
"user_id": "emptymalei", // Replace it with your own douban id
"artifacts": {
"local": "douban/douban__book_movie_music.json"
}
},
"status": {
"user_id": "1587390", // Replace it with your own douban id, only numerical id is supported: https://docs.rsshub.app/social-media.html#dou-ban
"artifacts": {
"local": "douban/douban__status.json"
}
}
},
"github": {
"events": {
"user_id": "emptymalei", // Replace it with your GitHub id.
"artifacts": {
"local": "github/github__events.json"
}
}
}
}
}
```