DoorBoard

Table of Contents

This is Team 007's iteration-three code for the DoorBoard web app, as part of The UMM CSCI Department's "Software Design and Development" class (Spring 2020).

• What is DoorBoard
• Features
• What's on your DoorBoard?
• What notes look like
• Discarded Notes
• Navigation Menu
• Share Menu (top right in toolbar)
• Known Issues
• Going Forward
• Deployment
• Authors

What is DoorBoard

DoorBoard is a virtual sticky-note board for office dwellers who need a way to remotely and conveniently post last minute scheduling announcements (or other information) to visitors.

Features

Doorboard includes:

• Authentication using Auth0.
• The ability to create a new note on your DoorBoard (with a 1000 character limit).
  • Notes display the date and time that they were created.
• The ability to move notes to trash.
• The ability to delete notes permanently from trash.
• The ability to switch to viewer mode. (This allows an owner of a page to see what their viewers would see.)
• The ability to create a door sign (in the form of a PDF) with the owner's name and link to their page.
• The ability to copy a link to the viewer page to the clipboard.

What's on your DoorBoard?

Your DoorBoard will display your name and any active notes.

What notes look like

Notes are created using the add button in the bottom right corner of the website. In addition to the text you write, notes display the date and time that they were created. They also include an edit button and a trash button; clicking the trash button will move a note into the discarded-notes section.

Discarded Notes

Once a note has been sent to the trash you can find it by navigating to the discarded-notes page. From here, notes can be permanently deleted. They can also be restored to your DoorBoard using the restore button.

Navigation Menu

This menu, on the left side of the toolbar, lets you navigate to your DoorBoard or your discarded notes, and it lets you see your DoorBoard in viewer mode. It also contains a logout button.

Viewer mode brings you to the page that your viewers are able to see. When you're still logged in, you will still have the tool bar with the navigation and share menu. However, if you aren't logged in, these controls won't be present.

Share Menu (top right in toolbar)

Here is where you can copy a shareable link to your viewer page and generate your personal door sign.

Known Issues

1. An issue sometimes occurs where the page will get stuck refreshing forever. This seems to happen most frequently on mobile browsers. The exact cause of this issue is currently unknown, although we have been able to reproduce the bug on an iPhone 7 running Safari.

2. Viewing another user’s DoorBoard while you are logged in yourself will keep the menu and share buttons on the toolbar at the top functional, although they will bring you to your own associated info rather than the user who owns the DoorBoard you were viewing.

3. The viewer-page.component.spec file still needs to have its tests written.

Going Forward

1. You may want to shorten the url to view a DoorBoard or attach a QR code to the door sign the page generates to make it easier for potential DoorBoard viewers to quickly and easily access a user’s page.

2. Note expiration dates were never fully implemented. You will likely want to either remove the expireDate field from the note.ts and note.java files, or finish implementing note expiration.

3. You may want to write e2e tests for your project, as this build does not currently have any.

Deployment

Instructions for how to set up the project are in DEPLOYMENT.md.

Authors

Benjamin Burgess
Ben Goldstein
Johannes Martinez
Jake Peterson
Joe Walbran