{"id":16865697,"url":"https://github.com/jibbarth/slacknewsletter","last_synced_at":"2025-04-11T09:55:05.691Z","repository":{"id":40294892,"uuid":"129633240","full_name":"Jibbarth/slacknewsletter","owner":"Jibbarth","description":"A Symfony Project to build a newsletter from slack workspace.","archived":false,"fork":false,"pushed_at":"2023-07-16T19:52:32.000Z","size":706,"stargazers_count":7,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T06:41:44.335Z","etag":null,"topics":["github-template","newsletter","newsletter-service","php","slack","slackbuilds","symfony","symfony5"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jibbarth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-15T17:18:26.000Z","updated_at":"2023-12-28T06:44:31.000Z","dependencies_parsed_at":"2025-02-19T03:32:11.540Z","dependency_job_id":"12c0f252-086e-4a62-bf44-7f1f04830a03","html_url":"https://github.com/Jibbarth/slacknewsletter","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jibbarth%2Fslacknewsletter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jibbarth%2Fslacknewsletter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jibbarth%2Fslacknewsletter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jibbarth%2Fslacknewsletter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jibbarth","download_url":"https://codeload.github.com/Jibbarth/slacknewsletter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248371306,"owners_count":21092985,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-template","newsletter","newsletter-service","php","slack","slackbuilds","symfony","symfony5"],"created_at":"2024-10-13T14:48:10.948Z","updated_at":"2025-04-11T09:55:05.662Z","avatar_url":"https://github.com/Jibbarth.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://repository-images.githubusercontent.com/129633240/a2815d80-adbe-11ea-9379-b3b04705d572\" alt=\"Slack Newsletter Preview\"\u003e\n\u003c/p\u003e\n\n# Slack Newsletter\n\n![CI](https://github.com/Jibbarth/slacknewsletter/workflows/CI/badge.svg?branch=master)\n![Version](https://img.shields.io/packagist/v/barth/slacknewsletter)\n\nThis application allows you to generate a newsletter from your [Slack](https://slack.com) channels.\nIt goes through the channels looking for links, combines them into a html file, and sends it by email.\nIt's ideal for keeping track of your finds when the historical Slack reaches its limit.\n\n## Installation \u0026 Configuration\n\n1. Clone the project and launch `composer install` inside.\n\n2. Generate a [Token on your slack workspace](https://github.com/Jibbarth/slacknewsletter/wiki/Generate-an-App-to-get-a-Token)\n\n3. In your `.env.local`, complete your smtp configuration, the receivers, and your Slack token like that :\n\n```\nMAILER_DSN=smtp://awesome-smtp:25\nRECEIVERS=me@example.net,mailing-list@example.net\nSLACK_TOKEN=xoxp-XXXXXXXXX-XXXXXXX-XXXXXXXXX\n```\n\n4. Choose your channels to browse and add them in `config/channels.json`.\nYou can check out the `config/channels.json.dist` to see how add a new channels\n\n5. (OPTIONNAL) : Pimp your newsletter by altering parameters in `config/package/parameters.yaml`\n\n6. Configure your cron to execute command to browse, build, and send newsletter.\n\nFor example :\n\n```bash\n## Every day at 8am, browse channels and store them\n0 8 * * * php bin/console app:newsletter:browse\n## Every monday at 8:05 am, build the newsletter and send it\n5 8 * * 1 php bin/console app:newsletter:build \u0026\u0026 php bin/console app:newsletter:send\n```\n\n## Build With\n\n* [Symfony 5.2](http://symfony.com/)\n    * symfony/console\n    * symfony/mailer\n    * symfony/yaml\n* [FlySystem from The Php League](http://flysystem.thephpleague.com/)\n* [jolicode/slack-php-api](https://github.com/jolicode/slack-php-api)\n* [Embed](https://github.com/oscarotero/Embed)\n* [Carbon](https://carbon.nesbot.com/)\n\nThank to theirs awesome work.\n\n## Customize the newsletter\n\nIf you want to customize the newsletter, all templates are in `templates` folder.\n\nBefore testing rendering, you have to retrieve some messages :\n\n```bash\nphp bin/console app:newsletter:browse -d 5\n```\n\u003e The `-d` or `--days` is to specified how many days to retrieve.\nYou can have lots of data by this way.\n\nTo test the view in web-browser, launch a web server :\n\n```bash\nsymfony local:server:start -d # With Symfony CLI binary\nphp -S localhost:8000 -t public # Using php built-in web-server\n```\nand go to [http://127.0.0.1:8000/test/mail](http://127.0.0.1:8000/test/mail)\n\nBut you probably have to send emails to test compatibility with emails viewer.\n\nYou can launch theses commands to avoid archivation of messages and builded news.\n\n```bash\nphp bin/console app:newsletter:build --no-archive\nphp bin/console app:newsletter:send --no-archive\n```\n\n## Contribute\n\nFirst of all, thank you for contributing ♥\n\nIf you find any typo/misconfiguration/... please send a PR or open an issue.\n\nAlso, while creating your PR, please write a description which gives the context and/or explains why you are creating it.\n\n## TODOs\n\n- [x] Make installation as simple as a `composer create-project barth/slacknewsletter`\n- [x] Browse private channel\n- [x] Make sure it'll work with [Slack App](https://api.slack.com/apps) and provide a configuration guide\n- [ ] Write Tests Suite\n- [ ] Add translations\n- [ ] Easily extend with other Team Collaboration Software (Discord, HipChat...)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjibbarth%2Fslacknewsletter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjibbarth%2Fslacknewsletter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjibbarth%2Fslacknewsletter/lists"}