README

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

• Project Title: Slack Announcement Automation

• Project description: We hope to provide a platform to collect announcements-to-be-announced from different request and to boost announcements automatically after review and approval.

• How to Install and Run the Project:

  1. "bundle exec Sidekiq" in terminal
  2. get ngrok started by "ngrok http 3000", get the new IP that looks like "https://ae2a-182-233-129-168.jp.ngrok.io" and update all the IP address in all the apps in Retool.

• How to use the Project:

  1. App Slack Scheduler - the interface for user to upload their announcements-to-be-shared and set a proposed announce date.
  2. App Slack Scheduler Admin - the admin interface to review and approve the collected messages.

• Ruby version

• System dependencies

• Configuration

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• ...