Documentation Plan (User and Admin)

User Documentation

Login

  1. To access the portal, go to https://mysmile.vercel.app.
  2. Either create a new account or login with your existing credentials.
    1. If you have forgotten your password, you can click “Forgot your password?”. A password recovery link will be sent to your email address. You may have to wait a few minutes to receive this email. Be sure to check your spam folder in case it is sent there.

Profile 

  1. In your profile view, you are able to see all your profile and contact information as well as if you have oriented or not.
  2. Once you have been oriented, your “Orientation Attendance” checkbox will be checkmarked.

Shifts 

  1. The shifts page displays all open shifts that are available to your specific role. If you have not attended orientation yet, you will only be able to see orientation shifts.
  2. To sign up for a shift, click the “Sign Up” button and you will see a confirmation pop up.

Schedule

  1. The schedule view displays all the shifts that you have signed up for with their appropriate date and time. You are also able to clock in and clock out for each shift.
  2. To unregister for a shift, simply navigate to the trash bin icon next to said shift. Once clicked, you should see a pop up asking for confirmation. After you click “Yes”, that shift will be removed from the view and you will have been officially unregistered for it.

 Files

  1. The files page allows you to upload any documents that you wish to upload to the site for admin users to view. Only files with specific naming conventions (as mentioned on the page) are allowed.
  2. Once you have uploaded a file, you will be able to see it, and any other uploaded files, under the “Uploaded” section.

Logout

  1. To logout of your account, simply press “Logout” on the top right of the screen.

Mobile View

  1. Users can view the https://mysmile.vercel.app site on their mobile devices as well.
  2. For convenience, the individual tabs are hidden and can be displayed upon clicking the “hamburger” icon at the top of the page.

Admin Documentation

In the Admin Documentation we will be discussing the following items:

  1. How to set up the codebase
    • Wake Smiles Github credentials
    • How to clone the github repository
    • Recommended extensions
  2. Walkthrough of admin portal and features
    • Admin portal login credentials
    • How to use the Stats page
    • How to use the Profiles table
    • How to use the Signups table
    • How to use the Shifts table
    • How to use the Files page
  3. Overview of admin portal code
  4. Gmail and Google Drive access
    • Gmail login credentials
    • Relevant documents and where to find them
  5. Supabase login and overview
    • Login credentials
    • Benefits to upgrading to the Pro tier (paid) version
    • Supabase documentation and walkthrough
    • How to access files
    • How to edit different tables
    • How to add an admin user
    • Data aggregation via SQL Editor
  6. Admin portal code notes
    • Notes from development
    • Future improvements
  7. Code security
  8. Develper contact info