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

7. "Installation" or Usage Instructions #7

Closed vsoch closed 5 years ago

vsoch commented 5 years ago

The installation, based on the README, is to "drag and drop the file in a browser." As a stupid Github user I could try grabbing the link to the file and dropping it in a new tab, and this obviously wouldn't work! I would suggest a more direct instruction that can first direct the user to a static url to preview the experiment, and then if the user wants to deploy on his / her own, provide complete instructions to:

  1. Fork the repository to their Github account
  2. Clone the forked repository
  3. Customize (in some way) if necessary?
  4. Either put on a local web server, or give instructions to deploy to Github pages.

Also, you could provide the user with a Dockerized version, which would let them run a Docker container bound to port 80 to run it immediately without needing to do cloning, etc. This would also be reproducible because you would have all versions of the software build into containers. let me know if you need help with this, glad to help with creating a Dockerfile and building the container with some CI (e.g., circleci) and pushing the container to Docker Hub.

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

gasparl commented 5 years ago

I added more precise instructions about how the application may be used.

I'm not sure though about the Dockerized version. I am completely new to this, but if I understand correctly the only advantage would be that separate versions are kept unchanged in these containers. But then downloading or cloning could do just the same, and these can be done extremely easily, literally with a few button clicks. (The huge green "Clone or download" button for the repository.) But if I misunderstand and there is more to this and/or you really think it would be relevant, then I would indeed appreciate it you helped out with the implementation :)

vsoch commented 5 years ago

The Dockerized version would provide a more production version, meaning that the various states of the repository are frozen in time (including system / host dependencies) and always available via a container. If a researcher were to use your test, they could rely on the commit but that still doesn't account for the web server and host it's running on. I'm reading in your manuscript now that the intended use case is research, so it might be more appropriate for some researcher to build a container to preserve the version / functionality that is wanted. So TLDR - it's really up to you. I'd be happy to help, but if you think it's overkill (or want to do it when someone asks for it) you can just ping me when that time comes.

gasparl commented 5 years ago

I see. It's really nice of you to offer. Still, it doesn't seem pressing, so I would like to ask you to let me off the hook for now. If someone does ask for it and/or this test will actually become frequently used (as I would wish), I will not hesitate to get back to you about this.

vsoch commented 5 years ago

Sounds good! You're off the hook! :) Closing issue.

gasparl commented 5 years ago

Thanks :)