diff --git a/Projects/Slack-Archiver.md b/Projects/Slack-Archiver.md index 5f450b74..cdad93e7 100644 --- a/Projects/Slack-Archiver.md +++ b/Projects/Slack-Archiver.md @@ -6,37 +6,36 @@ attractive to Open Source Software (OSS) teams since it supports a highly functional free tier. One problem is the free tier is limited to a maximum of 10K messages. When -this limit is reached older messages become unavailable since they are +this limit is reached older messages become unavailable since they are purged. This is very impactful to active Slack teams and communities since older messages quite often hold a great deal of "institutional knowledge" that's lost when the message limit is reached. -The Slack Archiver seeks to remedy this situation by extracting the history +The Slack Archiver seeks to remedy this situation by extracting the history for specific channels to an database or file. Messges could be extracted up to -the maximum allowed limit of 50 messages per minute for the `channels.history` +the maximum allowed limit of 50 messages per minute for the `channels.history` API method. At this rate (tier 4) 86.4K messages could be theorectically retrieved per day. Implementors are cautioned that further research will be required to -determine the best extraction method to use prior to attempting any +determine the best extraction method to use prior to attempting any development of this application. ## User Stories -- [ ] Allow the user to specify the channels to be archived. This includes -both adding and removing channels from the list -- [ ] Only the owners of the Slack Team should be allowed to archive -messages -- [ ] For each channel to be archived periodically extract messages starting -from the last message retrieved in the last extract and write them to a database). -- [ ] Allow the user to copy and extracted channel to a file -- [ ] Archiving should be an automatic process. Unlike a Slack 'bot, no -manual intervention should be required to start or stop and archive operation. +- [ ] Allow the user to specify the channels to be archived. This includes both adding and removing channels from the list +- [ ] Only the owners of the Slack Team should be allowed to archive messages +- [ ] For each channel to be archived periodically extract messages starting from the last message retrieved in the last extract and write them to a database +- [ ] Allow the user to copy and extracted channel to a file +- [ ] Archiving should be an automatic process. Unlike a Slack 'bot, no manual intervention should be required to start or stop and archive operation ## Bonus features -- [ ] Implememnt an API that allows an application to extract archived messages -from the archive database +- [ ] Implememnt an API that allows an application to extract archived messages from the archive database + +## Trello Board + +You can track your progress by cloning this [Trello Board](https://trello.com/b/yqsaX7fy/slack-archiver) ## Useful links and resources