seneca-cdot / osteppy Goto Github PK

Fix:

index b50b4ed..23b37f7 100644
--- a/development.yml
+++ b/development.yml
@@ -5,7 +5,7 @@ services:
     ports:
       - 127.0.0.1:27017:27017
 
-    mongo_express:
+  mongo_express:
     image: mongo-express:latest
     environment:
       - ME_CONFIG_OPTIONS_EDITORTHEME=default

Osteppy should send PR reminders at 10AM on weekdays.

Can be accomplished either by using Docker volumes/bind-mounts or MongoDB/Postgres containers.

Add emoji support to EODs.
Eg. If an emoji is added to the beginning of an EOD, it replaces the flag.

Also, a slash command to change preset default emojis for themselves.

Since Jan. 6, there were 4 EODs posted; they were dated:

EOD 1 - Jan. 4
EOD 2 - Jan. 3
EOD 3 - Jan. 2
EOD 4 - Jan. 1

The date is being subtracted by 1:

Add husky and lint-staged to run eslint and prettier in pre-commit hook.
Add prettier as an extension to eslint.

This ensures committed code is free of syntax errors and format inconsistencies.

/eods_left slash command should read the current users (sleepy RA's) who haven't submitted their EOD's.

So /eods_left need to read the sleepyRAs.txt file.

This bug only occurs when the sleepyRAs.txt is manually edited.

EODReminder.js' sendNextReminder loops through every RA and their reminders twice.
Instead, it should push reminders to the nextReminders array in the first loop and reset the array if a
"sooner" reminder is found.

When deciding whether to send EOD reminders, Osteppy doesn't currently know about holidays or college closures and will send reminders even on stat holidays or other times when the college is closed.

We should teach Osteppy about holidays to avoid sending reminders unnecessarily, possibly along with an override to always send reminders.

https://letsencrypt.org/

https://www.portainer.io/

Osteppy needs a single installation script which also detects which OS the system is on.

Slack users should be able to:

• See their EOD reminders times
• Edit their EOD reminder times
• Add or remove themselves from EOD reminder list

Create commands to add/remove EOD tasks to a temporary list, and (automatically?) submit them at the end of day.

This is needed for datetime-related features, for example currently EODs are not stored at the end of the day because of the wrong time zone.
There are two approaches:

• Read from .env
• Get the same time zone from the system running the container

This prevents updating from domains.json file.

During installation, there maybe config-files missing. Instead of errors, the necessary config-files should be created.
Config-files used:

• channelID.json
• EODReminderTimes.json
• eods.json
• RAs.txt
• SLACK_TOKEN
• sleepyRAs.txt

If a new user adds an EOD reminder, their slack username should be added to RAs.txt and return an error message to add their channelID to Osteppy/config-files/channelID.json.

Add a slash command for adding channelIDs.

Slash commands such as /add_eod_reminder should print user friendly formatted messages.

Eg. You've added this EOD reminder at 9:30PM for Monday's, Tuesday's, and Thursday's: "It's 9:30PM sleepy head, time to do your EOD!"

/eod slash command should have today's date in the title (today as in before 10AM).

Maybe add a /eod_past for people who need to submit eod's for previous days.

Readme needs instructions on setting up a Slackbot for EOD slash commands and EOD reminders.

Delete legacy/ as it is not needed. It will remain in git's history.

The osteppy.service should restart each time EOD-reminder-times.json is updated.

Latest tag (v1.0.0-alpha) seems not to work (checked on spain), however v0.54 works.

Suggestion: stick with v0.54 until latest tag goes RC.

Possibly related / dependent on #12, but I think it would be interesting to enhance the /eod endpoint (or add an additional endpoint?) so that the EOD workflow can be accessed through other tools in addition to Slack slash-commands.

My current EOD workflow looks like this:

1. Throughout the day, log tasks / issues / meetings / etc as I go or remember them
2. Open #general at end-of-day
3. Copy (really pbcopy) the contents of my task log
4. Type /eod into #general
5. Paste copied log contents into Slack
6. Submit EOD

Instead, it would be great if we could submit a (JSON-formatted?) payload to /eod, bypassing Slack entirely, and still have EODs get posted to #general by Osteppy.

Currently, /eod requires a response_url so that Osteppy knows where to send the EOD on behalf of the user:

https://github.com/Seneca-CDOT/ostep-dashboard/blob/00ee93b45644da6112da8a8c632017a3b5174710/Osteppy/src/server.js#L80-L82

which is the only part of the payload to /eod that is Slack-only and can't be replicated by other tools without first sniffing the response_url from a Slack slash-command invocation.

RA names and EOD reminder times should be kept in a config folder. Config folder contents are added to the .gitignore except for the .gitkeep.