db_web_framework

MySQL web app interface

https://github.com/pinskylab/db_web_framework

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization pinskylab has institutional domain (pinsky.marine.rutgers.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

MySQL web app interface

Basic Info
  • Host: GitHub
  • Owner: pinskylab
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Size: 36.1 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

Flask Web App Set Up For MySQL Database Interfacing

This project is a Flask web application designed to interact with a MySQL database. It provides various routes for managing sample data, querying information, and displaying documentation.

Prerequisites

Before you begin, ensure that you have the following installed on your system:

  • Python 3.x
  • MySQL Server (or access to a remote MySQL database)

Setup Instructions

1. Clone the Repository

Start by cloning this repository to your local machine:

```bash

Choose either http or ssh

http

git clone https://github.com/pinskylab/dbwebframework.git

ssh

git clone git@github.com:pinskylab/dbwebframework.git cd dbwebframework ```

2. Create Environment

```bash python3 -m venv env

Source Environment

source env/bin/activate ```

3. Install Dependencies

```bash pip install -r requirements.txt

Create your config which will be used to connect the app to the database

```

4. Configure the Environment

Ensure that you have the correct database credentials by modifying the config.py file. The Config class in config.py should look like this: python class Config: MYSQL_HOST = 'your_mysql_host' MYSQL_USER = 'your_mysql_user' MYSQL_PASSWORD = 'your_mysql_password' MYSQL_DB = 'your_mysql_database'

5. Set Up the Database

Ensure that your MySQL server is running and the database specified in the configuration (MYSQL_DB) exists.

You may need to set up the necessary tables and stored procedures for your application. If these are not already created, you can create them manually or consult your project documentation for instructions.

6. Run the Flask Application

Once the environment is set up, you can run the Flask application using the following command: bash python3 app.py By default, the Flask app will be available at http://127.0.0.1:5000

Owner

  • Name: Global Change Biology Research Group
  • Login: pinskylab
  • Kind: organization
  • Email: malin.pinsky@rutgers.edu
  • Location: New Brunswick, NJ

Advancing global understanding of populations and communities in a rapidly changing environment

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Roberts
    given-names: Roy L
    orcid: https://orcid.org/0000-0002-9056-7208
  - family-names: Devananda
    given-names: Abhita
    orcid: TBD
  - family-names: Pinsky
  given-names: Malin L
  orcid: https://orcid.org/0000-0002-8523-8952
title: "MySQL Flask Interface"
version: "1.0.0"
doi: TBD
date-released: TBD
url: "https://github.com/pinskylab/db_web_framework"

GitHub Events

Total
  • Push event: 15
  • Create event: 2
Last Year
  • Push event: 15
  • Create event: 2

Dependencies

requirements.txt pypi
  • Flask ==3.1.0
  • MarkupSafe ==3.0.2
  • markdown2 ==2.5.1
  • mysql-connector-python ==9.1.0