This repository provides a customizable template for building interactive web applications using the Dash framework in Python. The template is designed with a modular structure to help you quickly start developing scalable, data-driven dashboards with clean organization.
-
Modular Structure: The project is organized into distinct directories such as
components,pages,assets, andutils, each serving a specific purpose, ensuring that your codebase remains clean and maintainable. -
Pages The pages directory follows a modular structure, with each page containing its own
layoutandcallbacks. This separation helps keep the codebase organized and makes it easier to add new pages or modify existing ones. -
Asset Management:
assets: Contains static resources such as stylesheets (sass), scripts, images, and localized data (locales) to be used throughout the application.
-
Docker Support:
- Pre-configured
Dockerfileanddocker-compose.yamlto streamline the setup of a containerized development environment.
- Pre-configured
-
Logging Configuration:
- A customizable logging configuration file (
logging.conf) is included to help monitor and debug the application.
- A customizable logging configuration file (
- Python 3.x
- Docker (optional, for containerized development)
-
Clone the repository:
git clone https://github.com/MohammadSakhnini/dash-template.git cd dash-template -
Install Poetry and project dependencies:
pip install poetry poetry install
-
Run the application:
python app.py
If you prefer to run the application in a Docker container:
- Make sure docker is installed on your system and running.
- Build & run the container:
cd dash-template sh entry.sh
Feel free to customize the template according to your project requirements. The provided pages are merely examples showcasing the layout and can be modified or replaced as needed.
Contributions are welcome! Please fork the repository and submit a pull request with your changes.
This project is licensed under the MIT License - see the LICENSE file for details.