DIAWeb backend

Table of contents

1. Introduction
2. Project structure
3. Setting Up a Virtual Environment
4. Installing Dependencies
5. Running the Project
6. Contact data
7. License

Introduction

DIAWeb is a web application that allows the user to calculate their risk of suffering diabetes, based on an artificial intelligence powered model. This project is the backend of it, i.e., the API that computes such risk based on a range of biochemical markers.

Project structure

• .github/: Contains dependabot configuration along with workflow file
• mysite/: This directory contains the source code of the project
  • mysite/: Common Python files for all the apps, includings settings.py and urls.py
  • myapp/: App specific files, including test files, models, views and scripts to build and model the neural network
    • keras/: Tensoflow-Keras related scripts
    • migrations/: Database related scripts
    • utils/: Diverse utility files
  • db.sqlite3: Currently unused since the database is PostgreSQL
  • manage.py: Entry point to run the project.
• .gitignore: Folders not to include in the repository
• LICENSE.md: MIT license of the project
• CODE_OF_CONDUCT.md: Behavioural guidelines for contributors
• README.md: A briefing of the project and how to run it
• SECURITY.md: Briefing of the security policy
• devserver.sh: Boot file to run the project
• init_supabase.py: Script to initialize supabase database
• requirements.txt: List of Python dependencies of the project

Setting Up a Virtual Environment

To create a virtual environment, navigate to the project directory and run the following command:

python3 -m venv venv

This will create a new virtual environment in a folder named venv.

To activate the virtual environment, use the following command:

On Windows:

venv\Scripts\activate

On Unix or MacOS:

source venv/bin/activate

Installing Dependencies

Once the virtual environment is activated, you can install the project's dependencies using the requirements.txt file. Run the following command:

poetry install

This will install all the necessary packages for this project.

Running the Project

To run the project, navigate to mysite/ and then run

python manage.py runserver

Contact data

If you have any request or inquiry, feel free to contact me at [email protected]

Back to Top