diff --git a/.gcloudignore b/.gcloudignore index 10b6f1a..b1f0406 100644 --- a/.gcloudignore +++ b/.gcloudignore @@ -44,4 +44,5 @@ app_* LICENSE.md README.md requirements_local.txt -**/.DS_Store \ No newline at end of file +**/.DS_Store +.vscode/ \ No newline at end of file diff --git a/README.md b/README.md index 3a846e3..fb050aa 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# OmicsPred backend +# OmicsPred - backend Backend part of the OmicsPred Project @@ -6,6 +6,7 @@ Backend part of the OmicsPred Project * OmicsPred REST API website: [https://rest.omicspred.org/](https://rest.omicspred.org/) ## Roles + Manage import, querying and retrieval of the OmicsPred metadata: * Scripts to import the metadata and generate the genetic scoring files (app [imports](https://github.com/OmicsPred/omicspred_backend/tree/main/imports) -> [README](https://github.com/OmicsPred/omicspred_backend/tree/main/imports/README.md)) @@ -18,10 +19,9 @@ Manage import, querying and retrieval of the OmicsPred metadata: | Tool | Role | Version | | ---- | ---- | ------- | -| [PostgreSQL](https://www.postgresql.org/)| Database to store and query metadata | >= 18 | +| [PostgreSQL](https://www.postgresql.org/) | Database to store and query metadata | >= 18 | | [ElasticSearch](https://www.elastic.co/) | Server used as search engine | 8.xx (e.g. 8.19) | -| [Django ](https://www.djangoproject.com/) | Python framework to communicate with the database, the ElasticSearch indexes and build a REST API | 6.0.x (e.g. 6.0.7) | - +| [Django](https://www.djangoproject.com/) | Python framework to communicate with the database, the ElasticSearch indexes and build a REST API | 6.0.x (e.g. 6.0.7) | ## Setup @@ -47,15 +47,15 @@ Go to root of the repository (e.g. `cd .../omicspred_backend`) python manage.py search_index --create ``` - > [!WARNING] - > The indexing of the scores takes few hours (2-3h)! - To rebuild existing OmicsPred indexes: ```bash python manage.py search_index --rebuild -f ``` +> [!WARNING] +> The indexing of the scores takes few hours (2-3h)! + ## Deployment First of all, you need to rename and then update the file `app.yaml_template` to `app.yaml`. @@ -63,6 +63,7 @@ First of all, you need to rename and then update the file `app.yaml_template` to ### Local Run the command: + ```bash python manage.py runserver ``` diff --git a/requirements_local.txt b/requirements_local.txt index 12aa602..50cd2bf 100644 --- a/requirements_local.txt +++ b/requirements_local.txt @@ -6,4 +6,4 @@ openpyxl==3.1.5 PyYAML==6.0.3 # For testing only: -django-debug-toolbar==6.3.0 +django-debug-toolbar==7.0.0