Skip to content

✨ [NEW] - A production-ready template for building & deploying Streamlit apps with best practices and essential configurations. ⚡ Runs with uv

License

Notifications You must be signed in to change notification settings

cedanl/streamlit-app-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CEDA

Npuls-CEDA | Streamlit App template

🚀 Rapid Streamlit App Development Kit 🛠️
Production-ready template for building scalable Streamlit applications.
Ideal for data scientists, ML engineers, and Python developers seeking efficient app deployment

The ultimate streamlit app template. Built with ❤︎ by CEDA and contributors .

🔍 Purpose

This is a template repository designed to help developers quickly bootstrap high-quality Streamlit applications with standardized project structure and best practices.

Key Features

  • 🚀 Standardized Streamlit project layout
  • 🔒 Security and environment management
  • 🧪 Integrated testing frameworks
  • 📦 Dependency management
  • 🐳 Docker containerization
  • 🚢 Deployment-ready configurations
  • 🔍 Logging and monitoring setup

Demo

Check out the demo of the app in action:

App Demo

This GIF demonstrates the core features and user interface of the Streamlit application.

Ideal For

  • Data Science Teams
  • Machine Learning Engineers
  • Python Web Application Developers
  • Rapid Prototyping Enthusiasts

📁 Project Structure

├───data
│   ├───input
│   └───output
├───src
│   ├───assets
│   ├───config
│   ├───backend
│   └───frontend
│       ├───Files
│       ├───Home
│       └───Modules

Directory Descriptions

📂 data

  • input: Store raw data files and datasets used by the application.
  • output: Save processed data, results, and generated files.

📂 src

  • assets: Contains static files like images, CSS, and JavaScript.
  • config: Configuration files and settings for the application.
  • backend: Core logic, data processing, and API integrations.
  • frontend: Streamlit-specific code for the user interface.
    • Files: Components for file handling and uploads.
    • Home: Main page and dashboard components.
    • Modules: Reusable Streamlit components and widgets.

Key Features of This Structure

  • Separation of Concerns: Clear distinction between frontend, backend, and data management.
  • Scalability: Organized layout for easy addition of new features and modules.
  • Maintainability: Logical grouping of related files and functionalities.
  • Configuration Management: Centralized location for all configuration files.
  • Asset Management: Organized storage for static assets.

This structure provides a solid foundation for building complex Streamlit applications while maintaining code organization and project scalability.

🌟 How to Use This Template

For Organization Members

  1. Click "Use this template" green button on GitHub
  2. Name your new repository
  3. Choose visibility (Public/Private)
  4. Clone and start developing immediately

For External Contributors

  1. Fork the repository
  2. Customize to your specific Streamlit app requirements
  3. Remove or modify template-specific instructions

Quick Start

Accelerate your Streamlit app development with a professional, scalable template that follows industry standards and reduces boilerplate setup time. Technologies

  • Streamlit
  • Python 3.9+
  • uv
  • Docker
  • GitHub Actions
  • Pytest

🛠 Template Features

  • Pre-configured project structure
  • Standardized development workflows
  • Essential configuration files
  • Deployment-ready setup

📋 Customization Checklist

  • Update pyproject.toml
  • Configure environment variables
  • Modify application logic
  • Update documentation

🤝 Contributing

Please read CONTRIBUTING.md for details on our code of conduct and process for submitting pull requests.

Thank you to all the people who have already contributed to streamlit-app-template[contributors].

About

✨ [NEW] - A production-ready template for building & deploying Streamlit apps with best practices and essential configurations. ⚡ Runs with uv

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages