Skip to content

JordanTPhysics/Dashboarding

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation


Dashboarding

This repository uses the Google Places API found here https://developers.google.com/maps/documentation/places/web-service/text-search to scrape and clean place data found on Google Maps. It can be used for trip planning or as a tool to locate local businesses for marketing. There is a front-end API built with Next and ChartJS for data visualization.

Table of Contents

Features

  • Interactive Dashboards: Use ChartJS to create interactive charts
  • Modular Design: Easily add new data sources and visualization types.
  • Responsive Layout: Dashboards are mobile-friendly and adapt to different screen sizes.
  • Customizable: Configurable themes and settings allow users to personalize their dashboards.
  • Data Integration: Load data from various sources such as CSV files, databases, or APIs.

Installation

  1. Clone the repository:

    git clone https://github.com/JordanTPhysics/Dashboarding.git
    cd Dashboarding
  2. Create a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  3. Install the required dependencies:

    pip install -r requirements.txt

Usage

  1. Run the Dashboard:

    /api -> uvicorn main:app --reload
  2. Access the Dashboard: Open your web browser and navigate to http://127.0.0.1:8000/ to view the docs and endpoints available from the server

  3. Explore the Dashboard: Use the interactive elements to filter, zoom, and explore the data visualizations.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue if you have any suggestions or improvements. When contributing, please follow these guidelines:

  1. Fork the repository and create a new branch for your feature or bugfix.
  2. Make your changes and add tests if applicable.
  3. Submit a Pull Request with a detailed explanation of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.


Feel free to adjust this README to better match the specifics of your project or repository structure!