Skip to content

A web application for visualising and analysing mining project data. Features an interactive data table, project-specific dashboards with location mapping, and analytics visualisation tools. Built with FastAPI, Python, and modern web technologies.

License

Notifications You must be signed in to change notification settings

TomAllsop/Mining-Data-Viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mining Projects Explorer

A FastAPI-based web application that visualizes and analyzes mining projects data from Digbee's API. The application provides an interactive dashboard to explore mining projects, their locations, and nearby operations within a 500km radius.

Application Screenshots

Analytics Dashboard

Analytics Dashboard Visualizes commodity distribution and project status breakdown across the mining industry

Project List View

Project List View Interactive table showing detailed mining project information with sorting and filtering capabilities

Project Details

Project Details Detailed view of individual projects including location mapping and nearby operations

Features

  • 📊 Interactive data table of mining projects
  • 🗺️ Geographic visualization of project locations
  • 📈 Analytics dashboard with industry insights
  • 🔍 Detailed project views with nearby operations
  • 🌐 REST API endpoints for data access

Tech Stack

  • Backend: FastAPI, Python 3.8+
  • Frontend: JavaScript, HTML5, CSS3
  • Data Handling: Pydantic
  • Templates: Jinja2
  • API Integration: Requests

Installation

  1. Clone the repository:

    git clone https://github.com/TomAllsop/Mining-Data-Viewer.git
    cd Mining-Data-Viewer
  2. Create a virtual environment:

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

    pip install -r requirements.txt
  4. Run the application:

    uvicorn digbee_list_projects:app --reload

    OR

The application will be available at http://localhost:8000 or http://0.0.0.0:8000

API Endpoints

Endpoint Method Description
/api/mining-data GET Retrieve all mining projects
/api/nearby-projects/{project_id} GET Get projects within 500km radius

Project Structure

Mining-Data-Viewer/
├── digbee_list_projects.py   # Main application file
├── static/                   # Static assets
│   ├── project-dashboard.js
│   └── datatables-custom.css
├── templates/               # HTML templates
│   ├── index.html
│   ├── analytics.html
│   └── project_dashboard.html
└── requirements.txt        # Project dependencies

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

About

A web application for visualising and analysing mining project data. Features an interactive data table, project-specific dashboards with location mapping, and analytics visualisation tools. Built with FastAPI, Python, and modern web technologies.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published