2020-04-23 07:01:24 +00:00
# dda-masto-embed
2020-07-08 19:11:13 +00:00
[<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 )
2023-01-04 10:44:20 +00:00
## In brief
2022-03-11 10:31:38 +00:00
dda-masto-embed embedd either your timeline or answers to an specific post on your website.
2020-07-03 06:38:08 +00:00
* Uses JS, **no intermediate server** required,
2022-04-08 08:12:06 +00:00
* in answer mode you can decide to show only favorited answers in order to do upfront moderation
2022-03-11 10:31:38 +00:00
* example for embedding a timeline at [meissa-gmbh.de/news ](https://meissa-gmbh.de/pages/news/ )
* example for embedding answers to a specific post at [meissa-gmbh.de/sustainibility_microplastic ](https://meissa-gmbh.de/pages/about_meissa/gemeinwohl/sustainability_microplastic/ )
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-04-23 12:22:20 +00:00
2023-01-04 10:44:20 +00:00
## Development & mirrors
2023-01-20 13:43:28 +00:00
Development happens at: https://repo.prod.meissa.de/meissa/dda-masto-embed
2023-01-04 10:44:20 +00:00
Mirrors are:
2023-01-20 13:43:28 +00:00
* https://codeberg.org/meissa/dda-masto-embed (issues and PR)
* https://gitlab.com/domaindrivenarchitecture/dda-masto-embed (CI)
* https://github.com/DomainDrivenArchitecture/dda-masto-embed
2023-01-04 10:44:20 +00:00
## How it looks
2020-07-08 19:16:17 +00:00
2023-01-04 10:44:20 +00:00
## Include a timeline
2022-03-11 10:31:38 +00:00
2022-04-08 08:12:06 +00:00
Including a timeline needs the following html. The div with id `masto-embed` configures the timeline to be shown.
We use bootstrap for rough styling. More styling is up to you at the moment, help is welcome :-)
2022-03-11 10:31:38 +00:00
2020-07-03 06:38:08 +00:00
```
<!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-04-23 12:22:20 +00:00
2022-03-11 10:31:38 +00:00
Reference:
* `id` has to be `masto-embed`
2022-03-11 11:50:09 +00:00
* `account_name` is the name of your account.
2022-03-11 10:31:38 +00:00
* `host_url` the url of your mastodon instance.
2020-04-27 10:21:46 +00:00
2023-01-04 10:44:20 +00:00
## Using in reply mode
2022-03-10 09:46:22 +00:00
2022-03-11 10:31:38 +00:00
Including replies of one of your posts will work as follows:
```
<!doctype html>
< html >
< head >
< meta charset = "utf-8" / >
< title > masto-embed< / title >
< link rel = "stylesheet" href = "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css"
integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk"
crossorigin="anonymous">
< / head >
< body >
< div id = "masto-embed"
account_name="team"
replies_to="107937234506182462"
filter_favorited=false
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 >
```
Reference:
* `id` has to be `masto-embed`
2022-03-11 11:50:09 +00:00
* `account_name` is the name of your account.
2022-03-11 10:31:38 +00:00
* `host_url` the url of your mastodon instance.
* `replies_to` the id of your post.
* `filter_favorited=<true|false>` true will show only favorited replies, false will show every answer.
2020-04-23 12:22:20 +00:00
2023-01-04 10:44:20 +00:00
## Dev setup
2020-04-23 12:22:20 +00:00
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
2023-01-04 10:44:20 +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
2023-01-04 10:44:20 +00:00
## Releasing
2020-07-03 06:38:08 +00:00
### 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
2023-07-28 12:44:04 +00:00
## Development & mirrors
Development happens at: https://repo.prod.meissa.de/meissa/dda-masto-embed
Mirrors are:
* https://gitlab.com/domaindrivenarchitecture/dda-masto-embed (CI issues and PR)
* https://github.com/DomainDrivenArchitecture/dda-masto-embed
2021-06-29 07:54:03 +00:00
## License
2023-01-04 10:44:20 +00:00
Copyright © 2023 meissa GmbH
2021-06-29 07:54:03 +00:00
Licensed under the [Apache License, Version 2.0 ](LICENSE ) (the "License")
2023-07-28 12:44:04 +00:00
Pls. find licenses of our subcomponents [here ](doc/SUBCOMPONENT_LICENSE )
