Skip to content
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

improve layout of javascript files/folders to make clear where users are expected to edit things #104

Open
gureckis opened this issue Mar 4, 2024 · 2 comments
Assignees

Comments

@gureckis
Copy link
Member

gureckis commented Mar 4, 2024

currently the src/ directory has lots of .js files only some of which the experiment developer is expected to really edit (e.g., router.js). would make sense to move the files you aren't expected to touch (unless contributing bug fixes/new code to the base project) versus those that almost everyone will need to touch/edit when starting a new project

@gureckis gureckis added this to the first version (v0.1.0) 🌱 milestone Mar 4, 2024
@gureckis
Copy link
Member Author

Notes from meeting 3/13:

Names for things/restructuring file layout:

All these go in src/user

src/router.js - timeline? Pages? Major user editable (clean it up to remove at the bottom guards setup)
src/icons.js - rarely needs to be editing but maybe worth being in user space
src/App.vue - leave alone

ALL these go in src/internals? src/core?
src/config.js - do we need that to be editable? – they edit env files technically
src/createpinia.js - not user
src/main.js - not user
src/randomization - not user
src/seed - no user
src/subtimeline - not user
src/timeline.js not user
src/utils.js no user
src/stores - nothing user in there really
src/composables - nothing in there for users really

Components:
Internals or core?
1 folder per “page”?
Lib folder for library of common components used several places

Captcha “Route”

@gureckis gureckis self-assigned this Mar 25, 2024
@gureckis
Copy link
Member Author

notes today was that we make a src/user folder that contains the task and specific editable things that you might need in your experiment. the other components move to core/components and are named according to the core function. page-level/route-level components will be called Views. so for example InformedConsentView.vue. Might take a docs first approach on explaining this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant