pchlap/dataweb repository overview

⁠DataWeb

This repository contains the source code for the DataWeb project at Liverpool Hospital. This project is being developed using Python (3.5) and Django (2.0) web framework. The DataWeb project provides a framework under which various apps can be developed. See 'Project Structure' for a list of these apps and 'Development' for information on creating a new app.

⁠Project Structure

⁠patients

App that indexes Patients, Plans and Images found in various data sources on the hospital network, including Pinnacle and XIO. Provides an interface to users to search the index.

⁠qcl

QCL Dashboard app, providing overview and metrics of current QCLs found in Mosaiq.

⁠authenticate

Provides the authentication backend to the hospital's Active Directory Infrastructure.

⁠dbconnect

Provides tools to other apps to connect to external databases, eg. Mosaiq.

⁠static

Contains files to be statically served for the web application, such as images, css and js.

⁠templates

Contains project wide Django template files. App specific templates files are stored inside the app's template directory.

⁠Development

Dockerfile contains instructions to build an image with all required dependencies. An up-to-date version of this image is maintained on Docker Hub. The easist way to get started with development on DataWeb is to use Docker and Visual Studio Code.

⁠Setting up development environment

1. Install Docker⁠
2. Install Visual Studio Code⁠
3. Clone this source code repository: git clone https://[Your-BitBucket-Username]@bitbucket.org/swscsmedphys/dataweb.git
4. Open Visual Studio Code, and open a remote window by pressing the green icon in the very bottom right hand corner.
5. Select Remote-Containers: Open Folder in Container...
6. Browse to and open the DataWeb directory you cloned in step 3.
7. Select the DataWeb Development environment.
8. This will reopen the Visual Studio Code window, but this time it will open inside the docker container environment which has everything you need preinstalled to begin developing!

⁠Intializing the DataWeb database

When you first set up you development environment, the DataWeb database won't exist yet. Initalize it by running the Django Migrate task using the following steps:

1. Open the command palette within Visual Studio Code (Ctrl+Shift+P).
2. Type Tasks: Run Task... and select it.
3. Select Django: Migrate.
4. Confirm that the database is initialized in the terminal window that opens

In addition, you will need an admin user to test the application:

1. Open the command palette within Visual Studio Code (Ctrl+Shift+P).
2. Type Tasks: Run Task... and select it.
3. Select Django: Create Admin User.
4. Enter the details of the admin user in the terminal window that opens.

⁠Running the application

To launch the application, press F5 within Visual Studio Code. Once the application has started, you may navigate to http://localhost:8000⁠ and log in with the user admin user you created in the previous step.

⁠Libraries

⁠Web (css/js) libraries - Included in this repository

• AngularJS (1.6.6)
• Angular Material Design (1.1.0)
• Bootstrap (3.3.7)
• jQuery (3.2.1)