image-x-institute / scientific-method-app Goto Github PK

Hey @Lilys-Code and @pchlap
Just somenotes from today.
Lily I suggest you triage the below into issues, sort them on your board, then close this:

• Researchers should have name and an email for assignment
• Probably icebox: make lists of reviewers searchable or filterable?
• Do some quick interview with different staff members. Paul Keall to setup
• Maybe a good idea to develop the user stories into some flow diagrams. can use mermaid to do this directly in github if you want, example below
• Based on user stories, try to get more realistic data for checklist items, so not just 'item 1' 'item 2' etc.\
• deploy this via docker? this depend on your interest, Phil and I happy to help if you want to give it a try :-)

flowchart LR

A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]

I attempted to follow the setup instructions but they failed as I did not have the required depencies installed.
Can you add a requirements.txt file which lists the libraries required to run this code?

Once I installed django, the instructions worked well.
When I ran python3 manage.py runserver I git a development server at http://127.0.0.1:8000/ - however at this address I only got a 'page not found' error?

It would be nice to have some tests that the code is working. At a minimum, a script which sets up and deploys the server so we can check this runs without issues (also checks that dependencies are correct etc.).

I can almost write this script already, the main questions are:

• how to autocreate a super user when prompted?
• once we deploy, appropriate way in bash to check that it has worked, then shut it down elegantly (may need to start in a seperate process?)

I've put example below with comments indicating the steps I'm unsure of.

git clone https://github.com/ACRF-Image-X-Institute/scientific-method-app.git
cd scientific-method-app/
python3 -m venv venv  # create virtual environement
source venv/bin/activate   # activate environment
pip install -r requirements.txt  # install requirements
python manage.py makemigrations  # set up app as per readme
python3 manage.py migrate
python3 manage.py createsuperuser  # here, we get prompted for text input; how to handle this automatically?
python3 manage.py runserver  # how can we test this this worked properly, then shut it down elegaantly?

The django structure needs to be set up within the github repository.