Miladeb77/Y2_Genepanel_project

Develop a Flask-based Web Interface for PanelApp Data Visualisation

Open

#5 opened on Nov 27, 2024

View on GitHub
 (9 comments) (0 reactions) (2 assignees)Python (1 fork)auto 404
Frontendflaskgood first issuesprint3

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Trello: https://trello.com/b/WAMAUQjB/stp-year2-software-eng-project

Description: Create a Flask web application to provide a user-friendly interface for interacting with the PanelApp data stored in the database. The interface should allow users to visualise and query data dynamically.

Requirements:

  1. Frontend Features:
  • Develop a clean and simple UI using Flask templates (e.g., Jinja2) to display PanelApp data.
  • Include search functionality to filter data based on disorders, genes, phenotypes, or evidence levels.
  • Provide pagination for large datasets.
  1. Backend Features:
  • Use Flask to handle API requests and serve data dynamically from the database.
  • Implement appropriate routes for querying and returning filtered data.
  1. Performance and Usability:
  • Optimise queries for efficient data retrieval.
  • Add input validation to ensure the robustness of the application.
  1. Testing and Documentation:
  • Write unit tests to validate the functionality of the Flask routes and database queries.
  • Provide a README.md with setup instructions and usage details for the Flask app.

Contributor guide

Research direction
Examine the Flask application code, understand the PanelApp data schema, and verify which features from the checklist have been implemented. Look into the existing routes and templates to see what needs to be added or fixed.
Tech stack
pythonhtmlcss
Domain
full stackweb dev
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonFlaskHTML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65