A live instance of the production website can be found at http://willholbrook.com/
To a separate production instance can be deployed into a Docker environment.
- Instructions on how to install Docker can be found here. https://docs.docker.com/get-docker/
Once Docker has successfully been installed:
- Open a terminal in the root of the repository
- Run
docker-compose -f .\docker-compose-combined-populated.yml upto run a copy of the server with the databases populated and a combined frontend and backend.
This uses two docker images as described in the table below with the hash at time of submission:
| Docker Image | Link | Hash |
|---|---|---|
| analyst_report_summarizer_combined_populated | https://hub.docker.com/r/willholbrook/analyst_report_summarizer_combined_populated/tags | sha256:625754755f844986a21f67f45f42a92202fc70f5d106a10030faf061026cc93c |
| analyst_report_summarizer_database_populated | https://hub.docker.com/r/willholbrook/analyst_report_summarizer_database_populated/tags | sha256:15d2769871157cd757917c7e53156f9fb17f658f07bc2a61472ac2548e1800d4 |
Once the server is running the project can be accessed at at [localhost:8030] (http://localhost:8030). Pre-existing users already are listed in the following table. It is also possibkle to create new users.
| Username | Password | Description |
|---|---|---|
| test_gold_user | Gold007! | An account that has all of the gold standard reports uploaded in (contains duplicates) |
| test_superuser_username | test_superuser_password | A Django Admin account which can be used at website/admin to perform admin activitiees |
| test_user_username | test_user_username | A simple non-staff Django Account |
| DemoUser | DemoPass1! | A demo account which contains interesting reports with particularly useful summaries |
To access the website from other devices/over the internet, make sure it is possible port 8030 on the system running the docker containers.
To run the container on a port different to 8030, edit the file
./docker-compose-combined-populated.yml
and change the "ports" setting, replacing 8030 with the required port number.
For example change the following
10 ...
11 ports:
12 - 8030:80
13 ...
to
10 ...
11 ports:
12 - 80:80
13 ...
to run set the the website on port 80.
- Python - 3.8.10
- Node - 18.12.1
- Docker/Docker Desktop
- Client
- Cloud integration - v1.0.31
- Version - 20.10.23
- API version - 1.41
- Go version - go1.18.10
- Server: Docker Desktop 4.17.1 (101757)
- Engine
- Version - 20.10.23
- API version - 1.41 (minimum version 1.12)
- Go version - go1.18.10
- containerd
- Version - 1.6.18
- runc
- Version - 1.1.4
- docker-init
- Version - 0.19.0
- Engine
- Client
- Website Icon is used from https://www.flaticon.com/free-icon/the-sum-of_261941
This project makes use of multiple python modules some of which are only used for development and / or evaluation. These are listed below.
| Module | Version | Link |
|---|---|---|
| Django | 4.1.7 | https://pypi.org/project/Django/ |
| Pillow | 9.4.0 | https://pypi.org/project/Pillow/ |
| django-cors-headers | 3.13.0 | https://pypi.org/project/django-cors-headers/ |
| djangorestframework | 3.14.0 | https://pypi.org/project/djangorestframework/ |
| djangorestframework-api-key | 2.3.0 | https://pypi.org/project/djangorestframework-api-key/ |
| nltk | 3.8.1 | https://pypi.org/project/nltk/ |
| numpy | 1.24.2 | https://pypi.org/project/numpy/ |
| requests | 2.28.2 | https://pypi.org/project/requests/ |
| psycopg2-binary | 2.9.5 | https://pypi.org/project/psycopg2-binary/ |
| bert-extractive-summarizer | 0.10.1 | https://pypi.org/project/bert-extractive-summarizer/ |
| tensorflow | 2.11.0 | https://pypi.org/project/tensorflow/ |
| torch | 1.13.1 | https://pypi.org/project/torch/ |
Code in the package ./backend/api/grobid_client has
sourced and adapted from the python package grobid_client_python which can be found
at https://github.com/kermitt2/grobid_client_python
| Module | Version | Link |
|---|---|---|
| pytest | 7.2.1 | https://pypi.org/project/pytest/ |
| black | 23.1.0 | https://pypi.org/project/black/ |
| coverage | 7.2.0 | https://pypi.org/project/coverage/ |
| pre-commit | 3.1.0 | https://pypi.org/project/pre-commit/ |
| pylint | 2.16.2 | https://pypi.org/project/pylint/ |
| pylint-django | 2.5.3 | https://pypi.org/project/pylint-django/ |
| Module | Version | Link |
|---|---|---|
| requests | 2.28.2 | https://pypi.org/project/requests/ |
| pandas | 1.5.3 | https://pypi.org/project/pandas/ |
| seaborn | 0.12.2 | https://pypi.org/project/seaborn/ |
| scikit-learn | 1.2.2 | https://pypi.org/project/scikit-learn/ |
| openpyxl | 3.1.2 | https://pypi.org/project/openpyxl |
| rouge-metric | 1.0.1 | https://pypi.org/project/rouge-metric/ |
This project makes use of multiple node packages some of which are only used for development. These are listed below.
| Module | Version | Link |
|---|---|---|
| @testing-library/jest-dom | 5.16.5 | https://www.npmjs.com/package/@testing-library/jest-dom |
| @testing-library/react | 14.0.0 | https://www.npmjs.com/package/@testing-library/react |
| @testing-library/user-event | 14.4.3 | https://www.npmjs.com/package/@testing-library/user-event |
| @trivago/prettier-plugin-sort-imports | 4.1.1 | https://www.npmjs.com/package/@trivago/prettier-plugin-sort-imports |
| eslint | 8.35.0 | https://www.npmjs.com/package/eslint |
| eslint-plugin-react | 7.32.2 | https://www.npmjs.com/package/eslint-plugin-react |
| prettier | 2.8.4 | https://www.npmjs.com/package/prettier |
As Part of this project a number of docker images have been used as a base and then either built onto of or used as is. They are here as follows:
As part of the CI/CD pipelines this project makes use of the pre-made GitHub actions listed below
| Name | Version | Link |
|---|---|---|
| ssh-setup-action | v2 | https://github.com/marketplace/actions/ssh-setup |
| checkout | v3 | https://github.com/marketplace/actions/checkout |
| setup-python | v4.5.0 | https://github.com/marketplace/actions/setup-python |
| upload-artifact | v3.1.2 | https://github.com/marketplace/actions/upload-a-build-artifact |
| CodeCoverageSummary | v1.3.0 | https://github.com/marketplace/actions/code-coverage-summary |
| sticky-pull-request-comment | v2.5.0 | https://github.com/marketplace/actions/sticky-pull-request-comment |
| login-action | v2.1.0 | https://github.com/marketplace/actions/docker-login |
To ensure high code quality pre-commit hooks are used in this project. A description of how to use them can be found later in this file. Below is a table of the pre-commit hooks used.
| Name | Version | Link |
|---|---|---|
| trailing-whitespace | v3.2.0 | https://github.com/pre-commit/pre-commit-hooks |
| end-of-file-fixer | v3.2.0 | https://github.com/pre-commit/pre-commit-hooks |
| check-yaml | v3.2.0 | https://github.com/pre-commit/pre-commit-hooks |
| check-added-large-files | v3.2.0 | https://github.com/pre-commit/pre-commit-hooks |
| fix-encoding-pragma | v3.2.0 | https://github.com/pre-commit/pre-commit-hooks |
| black | 22.10.0 | https://github.com/psf/black |
| isort | 5.12.0 | https://github.com/PyCQA/isort |
| prettier | 'v2.7.1' | https://github.com/pre-commit/mirrors-prettier |
| eslint | 'v8.33.0' | https://github.com/pre-commit/mirrors-eslint |
This project makes use of pre-commit hooks. To install them first download pre-commit using pip:
pip install pre-commit
Then install the hooks specified in .pre-commit-config.yaml by running pre-commit install
Further details can be found here
Python pre-commit hooks are set up to only run on the "backend" directory and "JavaScript" are only set up for the frontend directory
This project comes with a postman collection
and a postman environment
which can be used for testing and development of the Web App.
These files are found in ./resources