!!! This project is under heavy refactoring to be soon a cool and modern Node.js project.
!!! Soon enough (begining of 2023) we should start shipping stable versions and have a main branch for less adventurous creators.
LabintheWild Study Templates - V2
This repository bundles together LabintheWild study templates and instructions to support developers with creating their own online studies.
This project is meant to help people with basic web development skills -- meaning HTML, CSS, JavaScript, and Node -- to bootstrap a LabintheWild study. Using it is not at all mandatory to be part of our researchers' community as a LabintheWild study is fundamentally implemented as a web application. If you have your own choices of technology you're free to use them as long as the study comply with some design guidelines presented in our tutorial.
Please consider submitting ideas and code to improve either the tutorial or this templates. This can be done by submitting an issue, creating a pull request for an open issue, or emailing us at: tech [at] labinthewild.org
Project structure
- DOCS: some documentation and howto guides.
- SRC: reusable resources to build a LabintheWild study
How is the SRC folder organized?
- css: Style sheet files;
- dist: Where built studies (JS bundles) will be saved;
- img: All sorts of images used in your study;
- include: Configuration and scripting files (mainly to deal with deployment and datasets);
- js: JS files that we chose not to install through NPM (for example, the LITW utility modules);
- templates: HTML templates for the study pages -- we use the Handlebars.js library to handle these.
Moreover, we have added some studies to get you inspired:
- STUDY-CATS: our beloved demo study presents choices of cats to help your find your future kitty.
- STUDY-BASE: the code you will likely want to use as the baseline of a new study.
What now?
Good to know that you got to this point. =)
Please visit the docs folder and learn: