diff --git a/Dockerfile b/Dockerfile index 8605d51c60da98b4836d4f39f0e4228a0842e9a2..594a7db6ed673f5256a62d7e8c16e776420e97cf 100644 --- a/Dockerfile +++ b/Dockerfile @@ -48,5 +48,5 @@ RUN ls SComplexity/online_app_backend.py RUN ls OnlineApp/enter_author_name.py RUN cp OnlineApp/enter_author_name.py . ENTRYPOINT /bin/bash -# ENTRYPOINT ["python", "OnlineApp/dash-asynchronous.py"] +ENTRYPOINT ["python", "OnlineApp/dash-asynchronous.py"] diff --git a/Documentation/DevelopingFrontEnd.MD b/Documentation/DevelopingFrontEnd.MD index 95f6d21c8008d7a6a8c5bae7bb27e5dd2f8cc465..afdb097e03435f3fa0574fbbcc8d5937d3563182 100644 --- a/Documentation/DevelopingFrontEnd.MD +++ b/Documentation/DevelopingFrontEnd.MD @@ -1,4 +1,4 @@ -How to finish the tool as a dash web-app: +### How to finish the tool as a dash web-app: Move contents from website to your computer hard-drive. ``` @@ -12,24 +12,36 @@ Build the docker image instead of pulling it from a remote. ``` sudo docker build . -t dash_mode ``` -Run what you buit: +Run what you built: ``` docker run -p 8050:8050 dash_mode ``` -Tweak the file: +Tweak [this file](https://github.com/russelljjarvis/ScienceAccessibility/blob/master/OnlineApp/dash-asynchronous.py) as it exists on your local hard drive remember the directory structure has been mapped faithfuly to your hard drive: ``` -ScienceAccessibility/OnlineApp/dash-asynchronous.py +atom ScienceAccessibility/OnlineApp/dash-asynchronous.py ``` +The link was not provided as an indication that you should edit the online file, it's provided as a navigation aid, as it's the file contents as they exist on your computer that we now care about. + Rebuild ``` sudo docker build . -t dash_mode ``` -Run what you buit: +Run what you built: ``` docker run -p 8050:8050 dash_mode ``` Test for desired output and if not desired output keep tweaking file. -Recommended, any easy to replicate minimal working example, that is a good foundation to build from. -https://arthought.com/dash-simple-deployment-with-docker/ +Recommended, any easy to replicate [minimal working example](https://arthought.com/dash-simple-deployment-with-docker/), that is a good foundation to build from. + + +You may also feel the need to tweak the last lines of [this file](https://github.com/russelljjarvis/ScienceAccessibility/blob/master/Dockerfile) as it exists on your local hard drive remember the directory structure has been mapped faithfuly to your hard drive: + +When the app works move your changes back onto the website with: + +```BASH +git add filename.py +git commit -m 'work-done' +git push origin master +``` diff --git a/Documentation/Documentation_Quick_Start.md b/Documentation/Documentation_Quick_Start.md index eb69645667b9b6edfa8abbf2fbb8d8764f824589..7449805f0b8fa3b284990dcf6ed5070a2a099557 100644 --- a/Documentation/Documentation_Quick_Start.md +++ b/Documentation/Documentation_Quick_Start.md @@ -12,7 +12,7 @@ After Docker installation on your Operating System, run the following commands i ```BASH docker pull russelljarvis/science_accessibility_user:latest ``` -Here is a python example to search for results from academic author Richard Gerkin. When inside the docker container, issue the command: +Here is a python example to search for results from academic author Sayali S Phatak. When inside the docker container, issue the command: ```BASH mkdir $HOME/data_words docker run -v $HOME/data_words russelljarvis/science_accessibility_user "Sayali S Phatak"