Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api message.json #19

Closed
JamsheedMistri opened this issue Dec 31, 2017 · 14 comments
Closed

api message.json #19

JamsheedMistri opened this issue Dec 31, 2017 · 14 comments
Assignees

Comments

@JamsheedMistri
Copy link
Contributor

Please add a file called message.json to the data/<api name>/ folder in the bell API. Each message would be in addition to the countdown.zone messages, if enabled. Format similar to the current message.json:

[{
  "message": {
    "enabled": true,
    "text": "Come check out the LAHS Hack Club!",
    "href": "https://lahs.club"
  }
}]
@nicolaschan
Copy link
Owner

How do you suggest it working with the global messages? Would this message override the global message until dismissed, and then would the global message show up immediately or after a refresh?

I'm concerned about users becoming frustrated at seeing more popup messages after dismissing the first one.

@JamsheedMistri
Copy link
Contributor Author

JamsheedMistri commented Dec 31, 2017 via email

@nicolaschan
Copy link
Owner

Multiple popups introduce the concern of blocking page content. I've been very careful so that when you resize the window, it is very difficult to get the popup to cover any text at all. I also don't want it to appear to be "spammy" because the more messages there are at once the less people pay attention to each one.

Would the nature of these messages make it more relevant to show up next to the current schedule name (such as an icon you can click for more information/to reveal the message)? Since these are per-school messages, I'm imagining that these messages would be related to the school's current (or upcoming) schedule, perhaps clarifying strange schedules (or different schedules for seniors, such as senior finals). Is that also what you had in mind?

@JamsheedMistri
Copy link
Contributor Author

JamsheedMistri commented Dec 31, 2017 via email

@nicolaschan
Copy link
Owner

Great! I also like that if we have a notification icon, they can click on it to view previously dismissed messages (such as perhaps they dismissed the "Install the Chrome Extension" message but now they want to install the extension). I'll write an update on this issue once progress has been made.

@JamsheedMistri
Copy link
Contributor Author

JamsheedMistri commented Dec 31, 2017 via email

@noloerino noloerino self-assigned this Feb 14, 2018
@nicolaschan nicolaschan added this to In progress in UI Enhancements Feb 19, 2018
@JamsheedMistri
Copy link
Contributor Author

@noloerino Just wondering if you have an ETA on this?

@noloerino
Copy link
Collaborator

i kind of forgot this existed whoops

i could probably find the time to do it

@JamsheedMistri
Copy link
Contributor Author

Thanks man

@nicolaschan
Copy link
Owner

I've implemented this in a pretty basic way just so @JamsheedMistri can control the message with the bell API. Let me know once you have this running and I'll close this issue.

Instructions for usage:

git clone https://github.com/nicolaschan/bell.git && cd bell
cp .env.example .env
vim .env # Edit .env for your API server (don't worry about the database stuff, just put "false' for everything)
# Put files in schedules/lahs/calendar.bell, etc. You may also include a message.json in that same folder.
yarn # Install dependencies
yarn api # Run API server

@JamsheedMistri
Copy link
Contributor Author

Test successful

@noloerino
Copy link
Collaborator

do i still need to work on the UI portion?

@nicolaschan
Copy link
Owner

Message management UI would still be great if you're up for tackling it.

@nicolaschan
Copy link
Owner

This has been running in production for awhile now and seems to be working well, so I'm closing this issue. Thanks to @JamsheedMistri for the suggestion and @noloerino for implementing.

UI Enhancements automation moved this from In progress to Done Dec 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

3 participants