Initial Commit

Dockerfile

@@ -2,20 +2,15 @@ FROM python:3.9-slim
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y \
-    build-essential \
-    curl \
-    software-properties-common \
-    git \
-    && rm -rf /var/lib/apt/lists/*
+# Copy requirements and install dependencies
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
 
-COPY requirements.txt ./
-COPY src/ ./src/
-
-RUN pip3 install -r requirements.txt
+# Copy the application code
+COPY . .
 
+# Expose the Streamlit port
 EXPOSE 8501
 
-HEALTHCHECK CMD curl --fail http://localhost:8501/_stcore/health
-
-ENTRYPOINT ["streamlit", "run", "src/streamlit_app.py", "--server.port=8501", "--server.address=0.0.0.0"]
+# Command to run the application
+CMD ["streamlit", "run", "app.py", "--server.address=0.0.0.0", "--server.port=8501"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jhwong19
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,20 +1,92 @@
+# Project: Delivery Route Optimization
+
+![Delivery Route Network](img/delivery-route-network.jpg)
+
+This project is a **Delivery Route Optimization** tool built using Streamlit. It aims to optimize delivery routes for a fleet of vehicles while considering constraints such as delivery time windows, vehicle capacity, and traffic conditions.
+
+
+### Key Features
+1. **Route Optimization**:
+   - Solve the **Vehicle Routing Problem (VRP)** to determine the most efficient routes for a fleet of vehicles.
+   - Incorporate constraints like:
+     - Delivery time windows.
+     - Vehicle capacity.
+     - Traffic conditions.
+
+2. **Map Visualization**:
+   - Display optimized routes on an interactive map using **Folium**.
+   - Highlight delivery stops, start and end points, and route distances.
+
+3. **Calendar View**:
+   - Provide a calendar-based schedule for deliveries.
+   - Allow users to view and manage delivery schedules for specific days or weeks.
+
+4. **Real-Time Updates**:
+   - Enable real-time updates for route changes due to unexpected events (e.g., traffic congestion, vehicle breakdowns).
+   - Re-optimize routes dynamically and update the map and calendar views.
+
+### Tools and Technologies
+- **Python**: Core programming language for optimization and application logic.
+- **Google OR-Tools**: Solve the Vehicle Routing Problem (VRP) with constraints.
+- **Streamlit**: Build an interactive web application for route visualization and schedule management.
+- **Folium**: Create interactive maps for route visualization.
+- **Synthetic Data**: Integrate real-time traffic data for dynamic route adjustments.
+
 ---
-title: DeliveryRouteOptimisation
-emoji: 🚀
-colorFrom: red
-colorTo: red
-sdk: docker
-app_port: 8501
-tags:
-- streamlit
-pinned: false
-short_description: Delivery Route Optimisation for parcel delivery schedules
-license: mit
+
+## Project Structure
+
+```
+streamlit-app-template
+├── src
+│   ├── app.py                # Main entry point of the Streamlit application
+│   ├── components            # Directory for reusable UI components
+│   │   └── __init__.py
+│   ├── pages                 # Directory for different pages of the application
+│   │   └── __init__.py
+│   ├── utils                 # Directory for utility functions
+│   │   └── __init__.py
+├── requirements.txt          # List of dependencies for the application
+├── .streamlit                # Configuration settings for Streamlit
+│   ├── config.toml
+├── img                       # Folder for storing images
+│   └── delivery_route_network.png
+├── .gitignore                # Files and directories to ignore in Git
+├── README.md                 # Documentation for the project
+└── LICENSE                   # Licensing information
+```
+
 ---
 
-# Welcome to Streamlit!
+## Installation
+
+To get started with this Streamlit application template, follow these steps:
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/yourusername/streamlit-app-template.git
+   cd streamlit-app-template
+   ```
+
+2. Create a virtual environment (optional but recommended):
+   ```
+   python -m venv venv
+   source venv/bin/activate  # On macOS/Linux
+   venv\Scripts\activate     # On Windows
+   ```
+
+3. Install the required dependencies:
+   ```
+   pip install -r requirements.txt
+   ```
+
+4. Run the Streamlit application:
+   ```
+   streamlit run src/app.py
+   ```
+
+---
 
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
+## License
 
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
+This project is licensed under the MIT License. See the LICENSE file for more details.

app.py

@@ -0,0 +1,35 @@
+# Main entry point of the Streamlit application
+
+import streamlit as st
+import sys
+from pathlib import Path
+
+# Import all pages from the pages module 
+from src.pages import home_page, about_page, contact_page, map_page, optimize_page
+
+def main():
+    st.set_page_config(
+        page_title="Delivery Route Optimization",
+        page_icon="🚚",
+        layout="wide",
+        initial_sidebar_state="expanded",
+    )
+    
+    st.sidebar.title("Navigation")
+    
+    # Sidebar navigation
+    pages = {
+        "Home": home_page,
+        "Map": map_page,
+        "Optimizer": optimize_page,  # Add the new page
+        "About": about_page,
+        "Contact": contact_page
+    }
+    
+    selection = st.sidebar.radio("Go to", list(pages.keys()))
+    
+    # Render the selected page
+    pages[selection]()
+
+if __name__ == "__main__":
+    main()

config.toml

@@ -0,0 +1,17 @@
+[general]
+email = "[email protected]"
+# The email address for the Streamlit sharing service.
+
+[server]
+headless = true
+port = 8501
+enableCORS = false
+# Configuration for the server, including running in headless mode and setting the port.
+
+[theme]
+primaryColor = "#F39C12"
+backgroundColor = "#FFFFFF"
+secondaryBackgroundColor = "#F0F0F0"
+textColor = "#000000"
+font = "sans serif"
+# Theme settings for the Streamlit application, including colors and font.

huggingface-metadata.yaml

@@ -0,0 +1,8 @@
+# File: .github/huggingface-metadata.yaml
+title: Streamlit Scheduler App
+emoji: 🚚
+colorFrom: indigo
+colorTo: blue
+sdk: docker
+app_port: 8501
+pinned: false

requirements.txt

@@ -1,3 +1,11 @@
-altair
-pandas
-streamlit
+streamlit>=1.24.0
+pandas>=1.5.0
+numpy>=1.23.0
+plotly>=5.13.0
+folium>=0.14.0
+streamlit-folium>=0.11.0
+requests>=2.28.0
+python-dotenv>=1.0.0
+ortools>=9.6.0
+geopy
+matplotlib