search

gasparl / citapp_pc

CITapp: a response time-based Concealed Information Test lie detector web application. This method aims to reveal whether or not a certain information detail (e.g. a photo taken from the scene of a recent burglary) is known to the tested person.
https://gasparl.github.io/citapp_pc/CITapp.html
BSD 2-Clause "Simplified" License
1 stars 3 forks source link

3. Online version #3

Closed vsoch closed 5 years ago

vsoch commented 5 years ago

You reference an "online version" on osf, but this isn't easy enough to use or interact with. I'd recommend you deploy the static files to Github pages for a preview that lives with (and thus is versioned with) the codebase. I would recommend having the demo in a "docs" folder on the master branch so you don't need to worry about updating a separate branch (gh-pages). If you need any help / have questions please ask and I will help you!

Review: https://github.com/openjournals/joss-reviews/issues/1179

gasparl commented 5 years ago

Brilliant, I didn't know it's so easy to host my page on Github - thank you for the suggestion! I'm not sure though what you mean by "having the demo in a "docs" folder". The application is now simply available via https://gasparl.github.io/citapp_pc/CITapp.html I would just leave it like that and refer to this in the repository and in the paper.

vsoch commented 5 years ago

Yes this is perfect! I suggested docs in the case that you wanted to keep some demo separate from the code that you provide to users, but this is a very good solution. And +1, let's make sure to add a link to this in the README (and the manuscript) so it's easy to find from multiple places.

vsoch commented 5 years ago

For the demo, it might be helpful to add hints / pre-filled in values for the content on the right (I don't know what to put) and most that are previewing likely won't have read through any documentation yet.

image

This would be the kind of reason to have the demo separate from the thing you are giving to users to deploy - the demo would have more learning tips / pre-filled in boxes for teaching.

gasparl commented 5 years ago

I added a demo possibility that can automatically fill these example using a button, but, for compactness, I simply added it as a new menu in the main application: image

So now it's available via the same page; https://gasparl.github.io/citapp_pc/CITapp.html. I added this link both to the paper and the README.

vsoch commented 5 years ago

This is totally awesome! I both love it and can say you went above my expectation to make it easier to learn how to use. This definitely closes this issue. Great work!