-
Notifications
You must be signed in to change notification settings - Fork 2
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
Move Resources out of Electron build #84
Comments
In GitLab by @jdanish on Apr 26, 2023, 12:28 Just seeing this. Did you want feedback? I agree with the framing! Though maybe we can change the folder name to not have Darwin since that all confuses folks. |
@jdanish yeah, please comment. This seemed to make the most sense to me. I'm less enamored of the idea of putting things in Maybe call the folder "MEME" or "MEME macOS" or "MEME Electron Application" instead of "meme-darwin-x64"? |
In GitLab by @jdanish on Apr 26, 2023, 13:17 I agree. I think the ideal for ease and assuming we aren't building an install anytime soon (or ever?) is just being able to zip a folder that folks download, and the app and data are all in the same folder. Calling it MEME macOS works for me. The structure works for me as well, and makes it easy to edit. I also like the idea that we provide a default in case the rest is hosed or deleted. I can provide those at some point once I know the format. Though given that we can't delete, I'd say one teacher, with one class, etc., makes the most sense? We might want a readme in there too, but it can go in the zip and I can handle it. Did I miss anything? |
A few more thoughts...
The easiest approach is probably to do what we're doing now: Edit the |
In GitLab by @jdanish on Apr 26, 2023, 14:37 I can certainly do that (edit those files). Realistically, if time is tight, another option is to just hide the db templates on the assumption that only I am likely to muck with them. If we can download the zip file and it runs, that'll work for 98% of our uses, and being able to send a replacement set of resources and or meme.loki handles the rest. Long-term I'd love to be able to have folks tinker with the rest, but realistically this might be all we need and then we wait until we can have the rest edited by a UI:
Or, maybe have a data folder with a sub-folder for templates and db
|
In GitLab by @jdanish on Apr 26, 2023, 14:41 Come to think of it, logs and screenshots can go under data so top level we have:
and then inside data:
Note I changed the readme to txt for normal people who aren't us 😄 |
Archiving the first proposed approach (ca. April 22, 2023) for historical purposes. THIS IS NOT THE FINAL DESIGN
|
@jdanish A few more questions about resources. We were anticipating that with different starting databases you might have completely different sets of resources that you would want to use. So rather than having the For example, if you wanted to do water quality investigations in one classroom and deer population investigations in another classroom, you could define a unique set of resources for each and store them in their respective (We had also toyed with the idea of auto-generating the resources list rather than having to define the Does that make sense? Or are you using resources in a different way? |
In GitLab by @jdanish on May 9, 2023, 09:01 That makes sense and I think the “default” can be empty since we would typically not have something across classes. For duplicating resources for 2 classes I assume we could copy and paste? |
This kind of depends on your setup. e.g. if you have one server computer and are setting up multiple teachers and multiple classrooms per teacher they would simply all share the same resources as defined the e.g. if you have two servers, one for water quality and one for deer population, then you probably want to define separate templates for each. If they share a same resource, then just duplicate the resource in both template folders. |
Once we get closer to an implementation, we should probably write up a guide, something to the effect of the slack post:
Also, a summary:
|
One additional note: Dragging MZIP files into the Electron app is a researcher feature for Reviewing a Database Archive -- "The original database has not been changed. You can import another archive. Quit and restart app to restore active database." It is not intended as a method of replacing the current running database. So to seed a classroom, you should use one of the three methods above (replace |
@scott.campion Some refinements of this as we work through the materials.
The main issue description contains the intended design. The discussion merely provides historical context. |
@Sakelun One possible clarification/refinement/oversight -- sorry I just realized this may not have been clear since I was focused on the end result. The folder structure in the description was assuming that this is the structure in the packaged Electron build. If I'm not mistaken, the packaged electron app currently sits at
...so with the changes, we're expecting the the built app would sit at:
...or whatever we decide to rename That leaves the question of where we should be putting the source data files a little unclear. But if we go with the principle of mirroring the app, then it makes sense to add the data files at:
...but perhaps you already were ahead of me on that... |
Implemented. |
A number of related issues:
meme.loki
was designed to work with macOS (e.g. in~/Documents/meme/
) but that does not work on Ubuntu and other OSes.meme.app
be distributed and saved? Do we expect people to drag it to "Applications" folder? Or do we distribute the fullMEME macOS
(wasmeme-darwin-x64
) folder?Principles
We want to bullet proof this for people who are downloading it for the first time.
meme.app
by itself with no resources, it should still be able to run and...meme.loki
database from a default_blank
database template burned into the Electron app.*.db.js
files have been defined in thedata/templates/meme
folder, a new loki db should be generated from those files.data/templates/meme
folder, then a new loki db should be generated fromdata/templates/_blank
files.meme.loki
file to be able to have a fallback -- e.g. just remove thememe.loki
file and a new one will be generated, either from thedata/templates/meme
files if they're defined, or fromdata/templates/_blank
.resources.db.js
needs to refer to specific resource URLs, we want to keep a copy of relevant sources with the saved db definitions.*.db.js
definitions (under the db directory, e.g.data/templates/meme/resources
) and copied over to the/MEME macOS/resources
folder during the loki build process. This way thedefault
andmeme
db.js definitions can refer to specific resources and we can guarantee that the resources will be present.Ideally, something like this?
The
*.db.js
files are:See also Dataset Management for info on loki file paths.
The text was updated successfully, but these errors were encountered: