D4 User Manual


Google Docs Link (recommended)

Certain Images may not be visible on WordPress.

User Documentation

Who?

  • The Micromoment Card Deck app is designed for two types of users: teachers and project faculty coordinators. The app will be used by teachers to plan micromoments for their students, and project faculty organizers will be able to modify already-existing activities and add new ones in response to teacher feedback.

User Skill Level

  • The Micromoment Card Deck app is designed to be user-friendly for all levels of computer and mobile experience. 

App Navigation – Click here for Video Assistance 

  • Upon opening the Micromoment Card Deck app, you will see the homepage, which will include the catalog of cards. Each card will represent a different micromoment activity. 

Tap/Click on the card to select an activity. This will bring you to a thorough explanation of the activity along with all necessary background data. 

To find a specific Micromoment you can type in the searchbar. 

Or tap the filter icon to the right of the search bar to filter out certain micromoments through duration or type. 

Editing and Adding Activities:

  • As a project faculty coordinator, you will be able to edit existing activities and add new ones based on teacher’s feedback. To access this functionality, enter this Route path “/edit39283940” at the end of the URL. Here you will be able to edit existing activities by tapping on “Select Card” or selecting the Title of your desired card number. 

To add a new activity, simply tap the “+ New Card” button and fill out the relevant information.

Administrator Documentation

User Skill Level

  • We assume that the administrator will be more knowledgeable than the user about the application’s technical details, but not to the same extent as the developer. We’ll make sure the administrator has access to the code repository so they can make necessary adjustments.

Github

  • Link : https://github.com/micromoment/Flash-Card-UI
  • The Micromoment GitHub repository will feature readme files that provides set up and other information about the app. It will have textual descriptions of how to work with the app. This documentation will be intended primarily for the administrators, with instructions on how to work the backend. 

Built With

  • IDE: Visual Studio Code
  • Frontend: React.js 
  • Backend: Express and Node.js
  • Database: MongoDB Atlas
    • Client will be given the link to the database to control/edit all the micromoments. 
    • Client was given login and password information through email. 
  • Testing framework: Jest

Deployment

  • Our team was responsible for the deployment of the app.
  • If the client would like to change any code in the future the instructions are laid out in the hand-off plan.