Skip to content

Releases: theRAPTLab/meme

v1.4.0-alpha

21 May 23:21
9a09938
Compare
Choose a tag to compare

Date Released: 1/26/2024

Branch: dev

Unreleased version focusing on Electron Build Updates.
Used for internal testing and teacher pilot testing.

  • Use "Claim" instead of "Idea" #144
  • Add visible comment id #145
  • Simplify evidence #143
    • The Evidence "Notes" field is now removed.
    • Evidence "Idea" and "ScreenShot" are shown by default. (And "Target" so that you can select a target).
    • After selecting a target, "Rating" and "Reason" are displayed and can be edited.
  • Update help text, evidence link label #138
  • Electron Build Updates -- Runtime folder structure and default/Resource packaging updates #135
    • Update default paths for resources etc for Electron
    • Update build process for cloning new projects from templates
    • Fix broken Electron build process, including code signing
  • Minor UI Fixes
    • Renamed evidence link #134
    • Fixed evidence count badge on resource pane l#134
    • Tweaked comments to include dynamic feedback on whether evidence is referenced #134

v1.3.1-final

21 May 23:07
Compare
Choose a tag to compare

Date Released: 5/8/2021

Branch: master

Final version used during Spring 2021 Implementation

  • Add reference to 1.3.1 release.
  • Minor visual changes to the evidence link to make it a bit more intuitive (maybe). Also changed to calling it an "idea"
  • Change IDEA to CONCLUSION in evidence link
  • Made comment boxes slightly wider.

v1.3.1-final

28 Jun 21:49
Compare
Choose a tag to compare

Date Released: 3/2/2021

Branch: master

This is a candidate release for Winter 2021 studies.

1.3.1 fixes a Uncaught (in promise) dbids must be array of ints error when navigating back to the models list after opening a model.

See Version 1.3.0-final release notes for details.

v1.3.0-final

28 Jun 21:49
Compare
Choose a tag to compare

Date Released: 2/22/2021

Branch: master

This is a candidate release for Winter 2021 studies.

It is 1.3.0 because of a change in the data format. See "Data Incompatibility Warning" below.

See https://gitlab.com/inq-seeds/boilerplate/-/releases for prior release notes.


Version 1.3.0 Release Notes

New Features

New features since v1.2.0-final release.

  • Model Cloning -- Both students and teachers can now clone models. Students can only clone models within their own group. Teachers can clone models to any other group, classroom, or teacher. Cloning a model to a classroom will make a model for every group in the classroom. If you clone a model to a classroom that does not have the same resources available, the system will warn you of the missing resources. It is up to you to make sure you add them and activate them. Note that this is an asynchronous feature intended to be used with relatively low numbers of groups (say less than 20). Cloning for a large number of groups may be problematic. The primary intent of this feature is to support template authoring. See !100.

  • Model Move -- Teachers can move models to different groups, classrooms, and teachers. Students cannot move models. See !100.

  • Model Deletion -- In addition, teachers and administrators can delete models as well as . Deleted models are not actually removed from the database. They are merely marked as "Deleted" and hidden from students, but shown in a different list for teachers and administrators. They can move the deleted model back to a student group to "undelete" it. See !100.

  • Bidirectional Arrows -- Processes' directionality can now be set to be bidirectional. A new "One Way / Two Way" toggle switch in the Mechanism Dialog sets the directionality. See !103.

  • Model List Sorting -- Models lists can now be sorted by any column.

  • Delete Resource -- Resources can now be deleted from the Resource list.

Misc Features

  • Classrooms Listed in Admin/Teacher Models Lists -- To help teachers and administrators manage models, classroom information is now included in the lists of models.

  • Mechanism Dialog Improvements -- The description text is now more legible. The directionality is also indicated in the Mechanism Dialog.

  • Mechanism Line Drawing Improvements -- Mechanism lines will now immediately update to show their selected status (before you had to move the hover away before selection state would show). Mechanism arrows now also properly show the hover and selection states. The hover state is now bluish to match the selection state (it had been a transparent orange, which was hard to read).

  • New Icons -- Resources for an assumption or idea now also can use a lightbulb and question makr icon.

Bug Fixes

  • Model Comments -- Comments on the model should now be properly saved. In prior versions, the model comment could sometimes get mixed up with comments on other objects because they inadvertently shared the same id.

  • Mech Dialog Errors -- If you switch models after a Mechanism Dialog was opened for editing (even if you close it), the model data would sometimes get corrupted. Fixed with !102.

Data Incompatibility Warning

Two changes in this release will make the models saved via Version 1.3.0 incompatible with prior versions. In general, should Version 1.3.0 can open projects from prior versions without errors, but there are some caveats:

  1. Comment ID for model-wide comment -- Any model-wide comments saved in Version 1.2.0 or prior will be lost when opened in Version 1.3.0. The model id has changed between the versions.

  2. Bidirectional Mech arrows -- Version 1.3.0 should be able to open Version 1.2.0 files with Mechanisms defaulting to unidirectional.

v1.2.0-final

28 Jun 21:49
Compare
Choose a tag to compare

Version 1.2.0

Date Released: 6/5/2020
(Production completed 6/5/2020, released 10/12/2020)

Branch: master

This is a candidate MEME release for the Fall 2020 studies.

It is 1.2 because of a change in the data format. See "Data Incompatibility Warning" below.


New Features

New features since the v1.1.0 Release:

  • npm start -- Beta.2 Feature: Added a npm start script for starting the application in a production environment like a Digital Ocean server. The command is equivalent to npm run dev only it does not replace the existing database files. See !96.

  • Why -- This adds a "Why" text field to Evidence Links so that students can document their rationale for selecting a specific rating. See !86.

  • Researcher Printing -- Researchers can now print individual models by going to http://localhost/#/print. See !87.

  • Improved Prop and Mech Dialogs -- The Description field for both the Prop Edit dialog and the Mech Edit dialog is now 2 rows high and has scrolling enabled in order to encourage students to enter longer text. See !88.

  • Outcome -- Added a new "Outcome" object. Renamed existing objects to "Entities" and "Processes". All object names can now be set via code. See !89.

  • Electron App Version -- The Electron app now shows the current version number. See !92.

  • Database Export / READONLY Import -- Database files can now be exported and imported read-only FOR RESEARCH ANALYSIS. Note that this feature is intended to support research analysis, and NOT for importing a database as a starting point for new data collection. See !93. Instructions are here: V. Researcher Analysis

Misc Features

A number of small features have also been added (see !95):

  • Help view reads object names from object definition
  • VBadges now fit longer badges up to 3 characters
  • Tools panel can now be collapsed
  • The "Create Evidence" link is now hidden while editing Evidence
  • Evidence links now scroll into view when they are opened
  • Model modification dates are now recorded and displayed in the various view managers.
  • Linking evidence to a model object has been optimized.

Bug Fixes

  • Setting target on an evidence link no longer triggers js error. See #28.
  • Link count badges now show the correct number of links
  • Resource View now properly shows the number of links
  • Long evidence descriptions are now correctly displayed

Data Incompatibility Warning

Version 1.2 database files adds:

  • a new "Why" field for Ratings. Version 1.2 can open and read 1.1 datafiles, but not vice versa. See !86 for details.
  • a new "type" field for objects, including a new "Outcome" object.


To Install and Run

Running the system involves building and packaging the application, and starting up a local server, admin interface, and student devices. These instructions assume you're familiar with working with Git and Node and using npm in the terminal.

I. Local Server

I.A. Check Out Local Server Code

This assumes you've already installed NodeJS. If you haven't, we recommend using nvm. This will allow you to select different Node versions. As of November 2019, we are currently using Node Version 10.9.0.

  1. Check out the dev branch.
  2. If you're using nvm, type nvm use to auto-load the recommended Node version (10.9.0). You may also need to type nvm install to install 10.9 if it's not already installed on your machine.
  3. npm ci -- You might need to install some packages before doing a clean.
  4. npm run clean:all -- Remove all existing database and node modules.
  5. npm ci -- Install node modules

I.B. Download Resources

The pdf and netlogo simulation resources are not currently in the repo. You will need to download them from the source (ask Joshua for them) and place them in the boilerplate/src/app-web/static/dlc folder.

I.C. Build and Run the Local Server

You should build and run the local server first just to make sure everything is working.

  1. npm run dev
  2. Point your browser at http://localhost:3000/ -- You should see the MEME login screen.

I.D. Start Production Server

If you want to run the server in a production environment, such as a Digital Ocean server, use a different start script.

  1. npm start
  2. Point your browser at http://<server_ip>:3000/ -- You should see the MEME login screen.

This will start the local server and load the existing meme database.

You can also create and use arbitrary databases. E.g. to create a new database, you would:

  1. Duplicate datasets/_blank, e.g. name it fall2020
  2. Start it up using the DATASET environment parameter, e.g. DATASET="fall2020" npm start
  3. You can quit/reboot/update the server, and start it up again with DATASET="fall2020" npm start and the data will be retained.

II. Building and Running the Electron App

Once you verify the local server is running, you can build and deploy a standalone Electron application for distribution to teachers, so all they have do to start a MEME server in their classroom is to double click on the MEME.app.

If you want to seed (no pun intended) a MEME Electron application with sample data, e.g. configure teachers, classrooms, and groups, example models, etc, you can just run the MEME application, make the changes, and then duplicate and the MEME.app.

The one thing that can't be easily changed via the admin interface are the resources, so generally it's best to download them first. (Technical note: By running the Electron app, you're automatically loading the db.js files in system/datasets/meme. If you want to edit the db.js files by hand for the Electron app, edit those.

To build and run the Electron app:

  1. Make sure all the resources you want to use are in the boilerplate/src/app-web/static/dlc folder.
  2. npm run package
  3. Find the app in boilerplate/dist/meme-darwin-x64/meme.app
  4. Double click the meme.app file to start it.
  5. Point your browser at http://localhost:3000/ -- You should see the MEME login screen.

You can copy and distribute the meme.app file by itself. But first, you might want to set up some template admin settings. See the "Admin Interface" section below.

NOTE: Because the meme.app Electron app is not a signed and notarized, you may have to disable some security features on your Mac to run it.

For more technical information about creating and managing the dataset, see:

Updating Resources in the MEME.app

If you've already built and distributed the MEME app and find that you need to add or change resources, you can still update resources in the MEME.app manually:

  1. Quit the MEME app.
  2. Find the "meme.app" file in your Finder.
  3. Ctrl-Click on the "meme.app" and select "Show Package Contents"
  4. Navigate to meme.app/Contents/Resources/app/web/static/dlc
  5. Copy your new resources into the dlc folder.
  6. Run the MEME app and use the admin interface to add the resources and assign them to classrooms.
  7. You can now duplicate the MEME app file and distribute it. The new resources should be included with the app.

III. Admin Interface

Use the interface to set up teachers, classrooms, groups, students, ratings definitions, criteria, sentence starters, and resources.

Each classroom can have its own ratings definition, criteria, and sentence starter, as well as a subset of the resources enabled for them. Resources are shared across all classrooms, but are only visible to the class if you enable it. This means you'll want to carefully set up each class's initial settings if you want them to be anything other than the defaults. No resources are enabled by default, so you will have to enable them for each class.

To access the Admin Interface:

  1. Start the Meme app.
  2. Point your browser at http://localhost:3000/#/admin -- You'll see the admin interface.

If you are running the server on a remote server, you can use the special ?danishpowers parameter to access the admin page.

IV. Client Machines

As of 1.0, the meme app should run on Chrome browsers on Mac laptops, Windows laptops, and Chromebooks. It should mostly work on Android tablets (though they have not been fully tested). Unfortunately there are known rendering issues with iOS Chrome.

IV.A. Install Screen Capture Extension

In order to capture screens when creating a new evidence, you will need to install the MEME Extension on each student machine.

  1. Check out https://gitlab.com/inq-seeds/screenshot
  2. Go to SETTINGS in Chrome (in "stacked dot" menu upper right)
  3. Go to EXTENSIONS (in left sidebar of settings screen)
  4. Enable Developer Mode
  5. Choose Load an Unpacked Extension
  6. Find the extension directory in screenshot repo
  7. Once the extension is installed, when students create a new evidence, a screenshot of the resource will be automatically captured.

NOTES:

  • As of November 2019, the extension has been confirmed to work with Chrome on macOS, Windows 10, and ChromeOS.
  • The screenshot only works when the Resource View is opened. If you're just viewing the Resource Library list, you can't capture the screen.
  • The app will work without the extension, but students will have to use other tools to capture the screen and manually insert them to evidence.

IV.B. Run as Student

To bring students into the app:

  1. Start the MEME app.
  2. In the admin interface, make sure you've created groups and added students to each group.
  3. Copy the student login tokens and h...
Read more

v1.1.0-final

28 Jun 21:49
Compare
Choose a tag to compare

Version 1.1.0-final

Date Released: 2/11/2020

Branch: master

This is the MEME release for the February 2020 IU study.

It is 1.1 because of a change in the data format. See "Data Incompatibility Warning" below.


New Features

New features since the v1.0.0 Release:

  • The "Zoom Out" button now pan and zooms out to the extent of the model regardless of the minimum zoom value and where your model is placed. (Previously it would only zoom out to 0.5 centered, so if your model was offscreen you wouldn't see it). See !80.

  • There is now a "Zoom 1:1" button that will pan and zoom to the upper left corner of the workspace where Components are added by default. See !80.

  • The workspace now has a light-colored rectangle to indicate the main intended model area to help students orient themselves. They can still place outside the artboard. See !80.

  • The database file is now automatically backed up each time you start the app (e.g. via npm run dev, npm run app, or double clicking the meme.app. The snapshots are saved in the runtime folder. See !82.

  • Research logging for comments now will include the comment id. See !79.

  • The default resources have been updated for IU. See !78.

Bug Fixes

  • Login tokens are not converted to upper case internally so that comment authors are properly matched. This fixes a bug where logging in with a different case would cause the system to think you were a different author and therefore not allow you to edit or delete your own comment. See !79.

  • Mech comments now use the database id as a refId. This fixes two bugs: 1. If a mech is reversed, the pathId is also reversed. This results in comments becoming disconnected because the referent pathId has changed. 2. If a mech is deleted, and then a new mech is created connecting the same two props, the new mech picks up the old mech's comments. Again, this is because the pathId is the same. See !81.

  • Component positions are now properly saved and restored. This fixes a bug where positions were being saved to the wrong database object id. As a result, components did not save their positions across app restarts. https://gitlab.com/inq-seeds/boilerplate/commit/46e30746739d937509fcc6fae219790ae0dfe211

Data Incompatibility Warning

Version 1.1 database files use a new id for Mech Comments. Version 1.1 can open and read 1.0 datafiles, but Mech comments will be detached from their parent Mechs. See !81 for details.



To Install and Run

Running the system involves building and packaging the application, and starting up a game server, admin interface, and student devices. These instructions assume you're familiar with working with Git and Node and using npm in the terminal.

I. Game Server

I.A. Check Out Game Server Code

This assumes you've already installed NodeJS. If you haven't, we recommend using nvm. This will allow you to select different Node versions. As of November 2019, we are currently using Node Version 10.9.0.

  1. Check out the master branch.
  2. If you're using nvm, type nvm use to auto-load the recommended Node version (10.9.0). You may also need to type nvm install to install 10.9 if it's not already installed on your machine.
  3. npm ci -- You might need to install some packages before doing a clean.
  4. npm run clean:all -- Remove all existing database and node modules.
  5. npm ci -- Install node modules

I.B. Download Resources

The pdf and netlogo simulation resources are not currently in the repo. You will need to download them from the source (ask Joshua for them) and place them in the boilerplate/src/app-web/static/dlc folder.

I.C. Build and Run the Game Server

You should build and run the game server first just to make sure everything is working.

  1. npm run dev
  2. Point your browser at http://localhost:3000/ -- You should see the MEME login screen.

II. Building and Running the Electron App

Once you verify the game server is running, you can build and deploy a standalone Electron application for distribution to teachers, so all they have do to start a MEME server in their classroom is to double click on the MEME.app.

If you want to seed (no pun intended) a MEME Electron application with sample data, e.g. configure teachers, classrooms, and groups, example models, etc, you can just run the MEME application, make the changes, and then duplicate and the MEME.app.

The one thing that can't be easily changed via the admin interface are the resources, so generally it's best to download them first. (Technical note: By running the Electron app, you're automatically loading the db.js files in system/datasets/meme. If you want to edit the db.js files by hand for the Electron app, edit those.

To build and run the Electron app:

  1. Make sure all the resources you want to use are in the boilerplate/src/app-web/static/dlc folder.
  2. npm run package
  3. Find the app in boilerplate/dist/meme-darwin-x64/meme.app
  4. Double click the meme.app file to start it.
  5. Point your browser at http://localhost:3000/ -- You should see the MEME login screen.

You can copy and distribute the meme.app file by itself. But first, you might want to set up some template admin settings. See the "Admin Interface" section below.

NOTE: Because the meme.app Electron app is not a signed and notarized, you may have to disable some security features on your Mac to run it.

For more technical information about creating and managing the dataset, see:

Updating Resources in the MEME.app

If you've already built and distributed the MEME app and find that you need to add or change resources, you can still update resources in the MEME.app manually:

  1. Quit the MEME app.
  2. Find the "meme.app" file in your Finder.
  3. Ctrl-Click on the "meme.app" and select "Show Package Contents"
  4. Navigate to meme.app/Contents/Resources/app/web/static/dlc
  5. Copy your new resources into the dlc folder.
  6. Run the MEME app and use the admin interface to add the resources and assign them to classrooms.
  7. You can now duplicate the MEME app file and distribute it. The new resources should be included with the app.

III. Admin Interface

Use the interface to set up teachers, classrooms, groups, students, ratings definitions, criteria, sentence starters, and resources.

Each classroom can have its own ratings definition, criteria, and sentence starter, as well as a subset of the resources enabled for them. Resources are shared across all classrooms, but are only visible to the class if you enable it. This means you'll want to carefully set up each class's initial settings if you want them to be anything other than the defaults. No resources are enabled by default, so you will have to enable them for each class.

To access the Admin Interface:

  1. Start the Meme app.
  2. Point your browser at http://localhost:3000/#/admin -- You'll see the admin interface.

If you are running the server on a remote server, you can use the special ?danishpowers parameter to access the admin page.

IV. Client Machines

As of 1.0, the meme app should run on Chrome browsers on Mac laptops, Windows laptops, and Chromebooks. It should mostly work on Android tablets (though they have not been fully tested). Unfortunately there are known rendering issues with iOS Chrome.

IV.A. Install Screen Capture Extension

In order to capture screens when creating a new evidence, you will need to install the MEME Extension on each student machine.

  1. Check out https://gitlab.com/inq-seeds/screenshot
  2. Go to SETTINGS in Chrome (in "stacked dot" menu upper right)
  3. Go to EXTENSIONS (in left sidebar of settings screen)
  4. Enable Developer Mode
  5. Choose Load an Unpacked Extension
  6. Find the extension directory in screenshot repo
  7. Once the extension is installed, when students create a new evidence, a screenshot of the resource will be automatically captured.

NOTES:

  • As of November 2019, the extension has been confirmed to work with Chrome on macOS, Windows 10, and ChromeOS.
  • The screenshot only works when the Resource View is opened. If you're just viewing the Resource Library list, you can't capture the screen.
  • The app will work without the extension, but students will have to use other tools to capture the screen and manually insert them to evidence.

IV.B. Run as Student

To bring students into the app:

  1. Start the MEME app.
  2. In the admin interface, make sure you've created groups and added students to each group.
  3. Copy the student login tokens and hand them out to students.
  4. Copy the IP address from the MEME app, e.g. http://192.168.1.10:3000
  5. On the students Chrome browser, enter that URL: http://192.168.1.10:3000
  6. Enter the student login token.

NOTES:

  • Each model is owned by a group. A group can have any number of students. Any student in the group will have full author access to the model when they log in.
  • Sticky note comments are tied to individual students, but any student can edit any comment made by a member of their group.

IV.C. Teachers Viewing and Commenting on Student Work

Teachers can log in and view student work much as a student would:

  1. Start the MEME app
  2. In the admin interface, select the teacher, and write down their login token, e.g. MSBROWN-VYFZ.
  3. Point your browser to the student login URL, e.g. http://192.168.1.10:3000 (you can also use localhost if you're on the server).
  4. Login with the token.
  5. You should have read-only comment access to...
Read more

v1.0.0-final

28 Jun 21:49
Compare
Choose a tag to compare

Version 1.0.0-final

Date Released: 11/19/2019

Branch: master

This is the feature-complete 1.0 release of the MEME application, released for the November 18, 2019 Rutgers study.


New Features

New features since the v1.0.0-beta release (see the beta release notes for the full list of features):

  • Screenshots are now supported via a Chrome browser extension.

  • Resources can now be edited via the admin interface.

  • Teacher, Classroom, and Group names can now be edited via the admin interface.

Bug Fixes

  • Setting the criteria for a comment would inadvertently change the comment id to the criteria id, making notes seemingly to disappear.

  • Research Logging has now been restored for all objects. (The database updates had broken a few log items).


To Install and Run

Running the system involves building and packaging the application, and starting up a game server, admin interface, and student devices.

I. Game Server

I.A. Check Out Game Server Code

This assumes you've already installed NodeJS. If you haven't, we recommend using nvm. This will allow you to select different Node versions. As of November 2019, we are currently using Node Version 10.9.0.

  1. Check out the master branch.
  2. npm ci -- You might need to install some packages before doing a clean.
  3. npm run clean:all -- Remove all existing database and node modules.
  4. npm ci -- Install node modules

I.B. Download Resources

The pdf and netlogo simulation resources are not currently in the repo. You will need to download them from the source (ask Joshua for them) and place them in the boilerplate/src/app-web/static/dlc folder.

I.C. Build and Run the Game Server

You should build and run the game server first just to make sure everything is working.

  1. npm run dev
  2. Point your browser at http://localhost:3000/ -- You should see the MEME login screen.

II. Building and Running the Electron App

Once you verify the game server is running, you can build and deploy a standalone Electron application for distribution to teachers, so all they have do to start a MEME server in their classroom is to double click on the MEME.app.

If you want to seed (no pun intended) a MEME Electron application with sample data, e.g. configure teachers, classrooms, and groups, example models, etc, you can just run the MEME application, make the changes, and then duplicate and the MEME.app.

The one thing that can't be easily changed via the admin interface are the resources, so generally it's best to download them first. (Technical note: By running the Electron app, you're automatically loading the db.js files in system/datasets/meme. If you want to edit the db.js files by hand for the Electron app, edit those.

To build and run the Electron app:

  1. Make sure all the resources you want to use are in the boilerplate/src/app-web/static/dlc folder.
  2. npm run package
  3. Find the app in boilerplate/dist/meme-darwin-x64/meme.app
  4. Double click the meme.app file to start it.
  5. Point your browser at http://localhost:3000/ -- You should see the MEME login screen.

You can copy and distribute the meme.app file by itself. But first, you might want to set up some template admin settings. See the "Admin Interface" section below.

NOTE: Because the meme.app Electron app is not a signed and notarized, you may have to disable some security features on your Mac to run it.

For more technical information about creating and managing the dataset, see:

Updating Resources in the MEME.app

If you've already built and distributed the MEME app and find that you need to add or change resources, you can still update resources in the MEME.app manually:

  1. Quit the MEME app.
  2. Find the "meme.app" file in your Finder.
  3. Ctrl-Click on the "meme.app" and select "Show Package Contents"
  4. Navigate to meme.app/Contents/Resources/app/web/static/dlc
  5. Copy your new resources into the dlc folder.
  6. Run the MEME app and use the admin interface to add the resources and assign them to classrooms.
  7. You can now duplicate the MEME app file and distribute it. The new resources should be included with the app.

III. Admin Interface

Use the interface to set up teachers, classrooms, groups, students, ratings definitions, criteria, sentence starters, and resources.

Each classroom can have its own ratings definition, criteria, and sentence starter, as well as a subset of the resources enabled for them. Resources are shared across all classrooms, but are only visible to the class if you enable it. This means you'll want to carefully set up each class's initial settings if you want them to be anything other than the defaults. No resources are enabled by default, so you will have to enable them for each class.

To access the Admin Interface:

  1. Start the Meme app.
  2. Point your browser at http://localhost:3000/#/admin -- You'll see the admin interface.

If you are running the server on a remote server, you can use the special ?danishpowers parameter to access the admin page.

IV. Client Machines

As of 1.0, the meme app should run on Chrome browsers on Mac laptops, Windows laptops, and Chromebooks. It should mostly work on Android tablets (though they have not been fully tested). Unfortunately there are known rendering issues with iOS Chrome.

IV.A. Install Screen Capture Extension

In order to capture screens when creating a new evidence, you will need to install the MEME Extension on each student machine.

  1. Check out https://gitlab.com/inq-seeds/screenshot
  2. Go to SETTINGS in Chrome (in "stacked dot" menu upper right)
  3. Go to EXTENSIONS (in left sidebar of settings screen)
  4. Enable Developer Mode
  5. Choose Load an Unpacked Extension
  6. Find the extension directory in screenshot repo
  7. Once the extension is installed, when students create a new evidence, a screenshot of the resource will be automatically captured.

NOTES:

  • As of November 2019, the extension has been confirmed to work with Chrome on macOS, Windows 10, and ChromeOS.
  • The screenshot only works when the Resource View is opened. If you're just viewing the Resource Library list, you can't capture the screen.
  • The app will work without the extension, but students will have to use other tools to capture the screen and manually insert them to evidence.

IV.B. Run as Student

To bring students into the app:

  1. Start the MEME app.
  2. In the admin interface, make sure you've created groups and added students to each group.
  3. Copy the student login tokens and hand them out to students.
  4. Copy the IP address from the MEME app, e.g. http://192.168.1.10:3000
  5. On the students Chrome browser, enter that URL: http://192.168.1.10:3000
  6. Enter the student login token.

NOTES:

  • Each model is owned by a group. A group can have any number of students. Any student in the group will have full author access to the model when they log in.
  • Sticky note comments are tied to individual students, but any student can edit any comment made by a member of their group.

IV.C. Teachers Viewing and Commenting on Student Work

Teachers can log in and view student work much as a student would:

  1. Start the MEME app
  2. In the admin interface, select the teacher, and write down their login token, e.g. MSBROWN-VYFZ.
  3. Point your browser to the student login URL, e.g. http://192.168.1.10:3000 (you can also use localhost if you're on the server).
  4. Login with the token.
  5. You should have read-only comment access to all student models in all of your classrooms.

Important Notes

Research Logs

  • Researcher logs can be found in meme.app/Contents/Resources/runtime/logs. Look for dated log files like meme.app/Contents/Resources/runtime/logs/2019-09102019-0910-log-102440.txt
  • Screenshots can be found in meme.app/Contents/Resources/runtime/screenshots.

NOTE: Over time research logs and screenshots can grow quite large. You'll want to keep an eye on disk space, especially if you use the same app over months.

Login Tokens

  • Student login tokens are based on group Ids. So if you delete a student from one group and add them to another, they will have a new token.
  • Teacher login tokens are based on their name, so if you update their name, they will have a new token.

Backups

We recommend daily backups. Better yet, back up after each classroom period.

  • The easiest way to backup is to just duplicate the whole MEME app.
  • If you want to save space, you can just grab the database file in meme.app/Contents/Resources/system/datasets/meme.loki (assuming you didn't rename the database or are running a different database file).

v1.0.0-beta

28 Jun 21:48
Compare
Choose a tag to compare

Version 1.0.0-beta

Date Released: 11/04/2019

Branch: dev

This is a feature-complete beta candidate for a 1.0 release for the November 18th Rutgers study.

It includes approximately 30 major (and minor) systems:

  • An SVG-based boxes and lines model renderer that automatically lays out objects, supports drag and drop, handles parent-child relationships, and can be zoomed and panned.
  • React-based model data controller, including:
    • An interface for creating, modifying, and deleting Components and Properties
    • An interface for creating, modifying, and deleting Mechanisms
    • An interface for creating, modifying, and deleting Evidence
    • An interface for marking the quality of Evidence
  • An interactive model objects list
  • A screen capture system that allows students to upload and attach images to their evidence.
  • A resource viewer that displays simulation, pdf, and other web content in an iframe and allows students to create evidence from it.
  • A resource browser that lists available resources and evidence objects created for each resource.
  • An evidence badge system that can display and link to evidence attached to components, properties, and mechanisms.
  • A flexible networked comment system that allows teachers, students, and their peers to comment on a variety of model objects, including components/properties, mechanisms, evidence, and the model itself. It is also used for adding notes on Resources.
  • A display system to show descriptions saved with components, properties and mechanisms.
  • A network data architecture that supports multiple simultaneous users logged in on different network devices to manipulate a shared model, with live updates as the model changes.
  • A user login and management system using tokens for easy login by both students and teachers.
  • A model management system for users to view and select their own models.
  • A view-only mode where users can view and manipulate models and add comments, but not otherwise change a model.
  • A help system that displays a general help dialog for students.
  • A networked administration interface for multiple teachers and administrators with separate interfaces to set up:
    • teachers accounts
    • classrooms and model viewing settings
    • define student groups
    • define student logs
    • customize ratings per classroom
    • customize criteria per classroom
    • customize sentence starters per classroom
    • customize resources available to each classroom
  • A customizable research logging system that allows researchers to flexibly define the output of student actions for research purposes.
  • A networked database server for handling multiple simultaneous users working on the same model.
  • A communication system (URSYS) for handling messages and maintaining data both between client-side components as well as with the server database.
  • A build system for producing standalone Electron applications.
  • A scripting system for starting, packaging, building, and selecting different combinations of database data and server startup.

v0.3.0-alpha

28 Jun 21:48
Compare
Choose a tag to compare

Version 0.3.0-alpha

Date Released: 5/29/2019

Third release for one-on-one UI pilot testing at Rutgers. It adds Electron App Build, Evidence Link Ratings, and Evidence Link Editing.

This is a proof of concept prototype release focused on supporting student's ability to connect evidence to an existing model.

Download Mac Electron Build

This release is available for download here: https://davidseah.com/jobs/inquirium/meme/boilerplate/

  1. Download the zip
  2. Unzip it (usually just double-click to unzip)
  3. Double click the "meme.app" file.
  4. Note the "Connect to:" info -- it should be your IP address with ":3000", e.g. "http://10.0.0.30:3000"
  5. Open a Chrome browser.
  6. Enter that connect to info as the URL, e.g. "http://10.0.0.30:3000"
  7. You should see the MEME example project load.
  8. If you don't see anything, open Dev Tools by hitting Command-Option-i. Check if there are any errors. Take a screenshot of the window and send it to [email protected], describing what you were trying to do. Please include your Mac model number, operating system, and browser version information.

IMPORTANT: Resources and Local Dev Build

[Ignore this if you're using the Electron app build]

If you're building and running this on a local development server, you'll need to download/copy over the resource references e.g. netlogo htmls and pdfs) by hand into the boilerplate/src/app-web/static/dlc folder. Otherwise the sources will not load.


New Features

  • E1. Evidence Ratings -- Each evidence link now has 3 stars that the student can use to rate the quality of evidence. The rating will appear with evidence badges (on top of Components/Properties). !12
  • E2. Delete Evidence Link -- Evidence Links can now be deleted. To delete: Expand the Evidence Link item in either the Resource Library or the Resource View. Click on the "Delete" button. !14
  • E3. Edit source and edit link target -- Evidence Link sources can now be changed to another source. To change it: Expand the Evidence Link item in either the Resource Library or the Resource View. Click Edit. Click on the source component (e.g. if it was linked to "Fish", click on "Fish). The source button should change to "Select" and you can now click on a new component as the new source. KNOWN BUG: Evidence Badges are not properly updating when you change an existing source.
  • M2. Components and Properties can now be edited. First select the component, then click on "Edit Component/Property" to edit it.
  • M2. New properties can now be added directly to a component. First select the parent component, then click on "Add Property" to add a new property.
  • M12. There is now an editable project Title !7
  • The resource definitions from the IU pilot1 have been merged into the main repo.
  • Resource files themselves are being stored on a separate web server: http://meme.inquirium.info. They need to be downloaded and placed into the app-web/static/dlc folder by hand. Eventually this will be scripted.

Fixes

  • Evidence Badges are now handled by a badge manager. !6
  • M1. Add "Add Node/Mechanism" button labels. !7
  • B1. New evidence title defaults to blank with placeholder. !7
  • E6. Auto trigger "Edit" mode. !7
  • E7. Separate "Notes" from "Evidence List" and B3. Evidence... !7
  • B5. Contract other expanded Evidence Links when creating a new Evidence Link. !7
  • Refactor EvidenceLink Note field to be locally controlled field. !8
  • Reactify dialog input field handling. !9
  • Refactor Resource Items. !10

Minor Fixes

  • Increase width of Evidence Links in Resource View. !7
  • Line up Resource View Note with top of iframe, allowing space for field label. !7
  • Remove old unused handlers. !7

Known Issues

  • The current build does not work on Microsoft Edge or FireFox. You need to use Chrome or Safari to run it.
  • Evidence Badges are not properly updating when you change an evidence link's existing source.

Still-unresolved issues from last release:

  • Saving data is not supported.
  • Evidence Link screenshots are canned placeholders.
  • Newly-created Evidence Link badges are not displayed in the right position on a Component/Property
  • This version has been optimized for a Chromebook set at 1366x768.
  • Touch support is currently spotty.

v0.2.0-alpha

28 Jun 21:48
Compare
Choose a tag to compare

Version 0.2.0-alpha

Date Released: 5/5/2019

Second release for one-on-one UI pilot testing at IU. It adds slightly improved evidence badge functionality.

This is a proof of concept prototype release focused on supporting student's ability to connect evidence to an existing model.

New Features

  • Evidence Badges (in Components and Properties) are now created and managed by an badge manager. This should improve click-responsiveness of the badges and addresses an issue in v0.1.0-alpha where duplicate badges were being created with each update.
  • Expansion Arrows now flip direction when they are expanded.
  • Clicking on an Evidence Badge now toggles the Evidence Link between expanded and contracted states.

Fixes

  • Evidence Badges are now easier to click.

Known Issues

  • Newly-created Evidence Link badges are not displayed in the right position on a Component/Property