README.md 4.37 KB
Newer Older
1
# NodeJS Converter of Mastodon export to HTML files
tykayn's avatar
tykayn committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
-------------------------
## FR: Présentation
#Mastodon propose d'exporter une archive de vos données de compte. Informations utilisateur, posts, comptes que vous suivez, qui vous suivent, que vous avez bloqué, médias que vous avez posté...
Mais il n'existe pas de moyen de visualiser tout le contenu de votre compte dans une jolie interface. Enfin, ça c'était avant.
Maintenant vous pouvez utiliser ce client frontend pour naviguer dans vos posts et obtenir des statistiques à propos de votre compte, des hashtags que vous avez le plus utilisé, des comptes pour lesquels vous avez fait le plus de favoris et bien d'autres choses merveilleuses.
Pour ce faire, suivez la documentation!

## Initialiser le projet Mastodon-archive-stats

Cloner le dépot et le faire fonctionner localement vous demandera d'avoir:
* git
* npm

```
git clone https://source.joinmastodon.org/tykayn/mastodon-archive-stats.git && cd mastodon-archive-stats
yarn && yarn start
```

Il vous faudra d'abord avoir le zip d'export de votre compte, que vous pouvez demander dans votre espace utilisateur.
Par exemple à cette adresse pour la meilleure instance Mastodon du fédiverse.

https://mastodon.cipherbliss.com/settings/export

" Vous pouvez demander une archive de vos pouets et médias téléversés. Les données exportées seront au format ActivityPub, lisible par tout logiciel compatible. Vous pouvez demander une archive tous les 7 jours. "

Quand votre archive est prête vous recevez un email vous invitant à cliquer sur un lien pour récupérer le zip.
Une fois ceci fait, vous allez pouvoir le décompresser et mettre son contenu dans le dossier **source_data** de ce projet.
Les fichiers .json et compagnie, hop, coupé collé et voilà les informations à disposition du script.

La config du projet se trouve dans le fichier main.js dont vous pouvez modifier la configuration de l'export. Pour par exemple n'afficher que les Toots de plus de 500 caractères, ou seulement ceux comportant des médias, et choisir le sens de priorité du filtrage.
Vous avez le choix de sauvegarder le html rendu de l'export, ainsi que les statistiques générées dans un fichier séparé.

Ensuite il vous suffira de lancer le serveur nodejs local avec un "yarn start", aller sur http://localhost:8080 et TADA! Votre export visuel est là.

Have fun!


-------------------------
## EN: About
This is a frontend visualizer to grasp some data about what you did on an export from your Mastodon account.
Follow this doc to know how to use it.


45 46 47
install dependencies
Run the main.js file

ty kayn's avatar
ty kayn committed
48 49 50 51 52
It will create a file showing your longest posts if you want.

initialize this project with its dependencies, copy paste the source_data of your linkes.json and outbox.json to get an HTML export on a node server.
```bash
git clone https://source.joinmastodon.org/tykayn/mastodon-archive-stats.git && cd mastodon-archive-stats
ty kayn's avatar
ty kayn committed
53
yarn && yarn start
ty kayn's avatar
ty kayn committed
54 55 56 57 58 59
```
copy paste the source_data of your linkes.json and outbox.json to the **source_data** folder

open your browser to 
http://localhost:8088/
and you will see the result in html.
ty kayn's avatar
ty kayn committed
60 61 62 63
# TODO
    * show avatar of users
        * needs a fetch to instance
        * keep pictures in cache
ty kayn's avatar
ty kayn committed
64 65 66
## What statistics does this provide
For the moment:
* who you talked to the most, with counters. This uses the object.cc field of a toot.
ty kayn's avatar
ty kayn committed
67 68
* link to search on duckduckgo for hashtags and usernames 
* what are your most used hashtags
ty kayn's avatar
ty kayn committed
69 70
* options in main.js file
    * enable saving of statistics in json
ty kayn's avatar
ty kayn committed
71 72 73 74
* you can filter:
    * only toots with medias
    * change the order of filter
    * min length of toot content
ty kayn's avatar
ty kayn committed
75
* what toots are containing at least a certain number of characters. You can use this to retrieve some long posts you made, to post them on a worthy place where you would develop your subject deeper. Somewhere like on your personal website, thats an easy way to find your longests posts. But be careful, it could also show how much you talk with trolls :D 
ty kayn's avatar
ty kayn committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

## configuration
Change vars in the main.js file.

## Format restriction
this viewer works with archives exported at the time of this writing, July 2020.

## That is messy code with a bad UI and you should feel bad
it is, yes!
Feel free to contribute with a merge request.

#Contact me
Tykayn on mastodon, on my own instance: 
https://mastodon.cipherbliss.com/@tykayn

Other works about web and drawings: 
https://www.cipherbliss.com
https://tykayn.fr