dda-masto-embed/README.md

89 lines
2.7 KiB
Markdown
Raw Normal View History

2020-04-23 07:01:24 +00:00
# dda-masto-embed
2020-07-08 19:11:13 +00:00
![build](https://github.com/DomainDrivenArchitecture/dda-masto-embed/workflows/build-it/badge.svg)
[<img src="https://meissa-gmbh.de/img/community/Mastodon_Logotype.svg" width=20 alt="team@social.meissa-gmbh.de"> team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org)
2020-07-08 19:16:17 +00:00
## in brief
2020-07-09 15:33:48 +00:00
Embeds mastodon timeline into a html page.
2020-07-03 06:38:08 +00:00
* Uses JS, **no intermediate server** required,
2020-07-08 18:57:12 +00:00
* example at [meissa-gmbh.de](https://meissa-gmbh.de/pages/news/)
2020-07-03 06:38:08 +00:00
* Download latest version at:
2022-03-11 08:49:23 +00:00
* [dda-masto-embed.js](https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js)
* [dda-masto-embed.js.sha256](https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js.sha256)
* [dda-masto-embed.js.sha512](https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js.sha512)
2020-07-03 06:38:08 +00:00
* It is **OpenSource** - published under the Apache License, Version 2.0
2020-07-08 19:16:17 +00:00
## how it looks
![masto-embed-example.png](doc/masto-embed-example.png)
## how to try it out
2020-07-03 06:38:08 +00:00
In order to try it, just create a html like
```
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<title>masto-embed</title>
2020-07-08 19:16:17 +00:00
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css"
integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk"
crossorigin="anonymous">
2020-07-03 06:38:08 +00:00
</head>
<body>
<div id="masto-embed"
account_name="team"
host_url="https://social.meissa-gmbh.de">
Here the timeline will appear.
</div>
<script src="https://domaindrivenarchitecture.org/downloads/dda-masto-embed.js"></script>
</body>
</html>
```
2020-07-09 15:33:48 +00:00
We use bootstrap for rough styling. More styling is up to you at the moment, help is welcome :-)
2020-04-27 10:21:46 +00:00
2022-03-10 09:46:22 +00:00
## using in reply mode
Add `replies_to=<REPLY-ID>` and optionally whether you only want to include favorited replies as
2022-03-10 09:48:28 +00:00
`filter_favorited=<true|false>` to the div.
2022-03-10 09:46:22 +00:00
Instead of embedding all Posts of one account, this will fetch the replies to one Post and display them
2020-07-03 06:38:08 +00:00
## dev setup
2020-04-24 15:26:42 +00:00
```
2020-07-03 06:38:08 +00:00
npm install -g npx
npm install -g shadow-cljs
npm install -g source-map-support --save-dev
npm install
2020-04-24 12:42:30 +00:00
shadow-cljs watch frontend
2020-06-19 13:02:24 +00:00
```
open browser at http://localhost:8080
Connect your repl for :frontend
2020-07-03 06:38:08 +00:00
## run the tests
2020-06-19 13:02:24 +00:00
```
2020-04-24 15:26:42 +00:00
shadow-cljs compile test
```
2020-07-03 06:38:08 +00:00
## releasing
### prod release
```
#adjust version
2020-07-08 07:25:44 +00:00
vi package.json
2020-07-08 18:42:46 +00:00
git commit -am 'releasing'
2020-07-03 06:46:59 +00:00
git tag -am 'releasing' <version>
git push --follow-tags
2020-07-03 06:38:08 +00:00
# Bump version
2020-07-08 18:42:46 +00:00
vi package.json
2020-07-03 06:38:08 +00:00
git commit -am "version bump" && git push
2020-07-08 19:19:54 +00:00
```
2021-06-29 07:54:03 +00:00
## License
Copyright © 2021 meissa GmbH
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")
Pls. find licenses of our subcomponents [here](doc/SUBCOMPONENT_LICENSE)