Install and Setup

To get started with the app, follow these steps for installation and setup:

1. Clone the Repository
   Clone the project to your local machine and navigate to the directory where the project was cloned:

   git clone https://github.com/amirjaf/equity_dash.git
   cd equity_dash

2. Data Request
   Request the necessary data and place it in the src/assets/data directory. If the data folder does not exist, create it first:

   mkdir -p src/assets/data

3. Install the Virtual Environment and Requirements
   Make sure your system has Python installed and the functionality to create a virtual environment.

python -m venv .venv                            # Create a virtual environment in the current directory
.venv\Scripts\pip install -r requirements.txt   # Install the required dependencies

4. Run the Dashboard Application
   Run the Dash app from the current directory:

.venv\Scripts\python src\app.py                 # Run the application

Structure

The following is an overview of the structure.

dash-app-structure
|-- .venv
|   |-- *
|-- .gitattributes
|-- .gitignore
|-- Dockerfile
|-- License
|-- Procfile
|-- README.md
|-- requirements.txt
|-- src
|   |-- assets
|   |   |-- logos/
|   |   |-- css/
|   |   |-- images/
|   |   |-- favicon.ico
|   |-- components
|   |   |-- __init__.py
|   |   |-- footer.py
|   |   |-- navbar.py
|   |   |-- navbar_vertical.py
|   |   |-- line_chart_AIO.py
|   |   |-- pie_chart_AIO.py
|   |-- pages
|   |   |-- __init__.py
|   |   |-- tour_page
|   |   |   |-- __init__.py
|   |   |   |-- hispanic.py
|   |   |   |-- income.py
|   |   |   |-- load_tour_data.py
|   |   |   |-- main.py
|   |   |   |-- race.py
|   |   |-- trip_page
|   |   |   |-- __init__.py
|   |   |   |-- hispanic.py
|   |   |   |-- income.py
|   |   |   |-- load_trip_data.py
|   |   |   |-- main.py
|   |   |   |-- race.py
|   |   |-- home.py
|   |   |-- not_found_404.py
|   |-- utils
|   |   |-- __init__.py
|   |   |-- api.py
|   |   |-- data_handling.py
|   |   |-- data_loader.py
|   |   |-- images.py
|   |   |-- settings.py
|   |-- app.py
|   |-- cache.py
|   |-- gunicorn_config.py
|   |-- server.py
|-- tests
|   |-- *

Environment Variables

The .env.development file is where you should store sensitive information such as passwords or API keys.
This is a common practice to avoid hardcoding keys directly into your application, which could expose them to potential security risks.
Some common values found in .env.development files include DATABASE_URI or API_KEY.

You can also substitute this file with another .env file, such as .env.production, when running the app in different environments (e.g., development vs. production). To do this, set the ENVIRONMENT_FILE environment variable to point to the desired .env file. For example:

export ENVIRONMENT_FILE=.env.production

Acknowledgment

The software architecture design is inspired by this repository.