Skip to content

keith-gamble/example-perspective-component-module

Repository files navigation

Example Component Library for Ignition Perspective

License: MIT

A comprehensive example and guide for creating custom components in Ignition Perspective. This repository demonstrates best practices, development workflows, and proper module structure through working examples.

📚 Documentation

Visit our documentation site to learn:

  • How to set up your development environment
  • Step-by-step guides for creating components
  • Best practices and naming conventions
  • Build system configuration
  • CI/CD setup guides

🚀 Quick Start

  1. Clone the repository:

    git clone https://github.com/keith-gamble/example-perspective-component-module.git
    cd example-perspective-component-module
  2. Set up your development environment:

    # Copy gradle properties template
    cp gradle.properties.template gradle.properties
    
    # Install web dependencies
    cd web && npm install
  3. Start the development environment:

    # Start Ignition in Docker
    cd docker && docker-compose up -d
    
    # Build and deploy the module
    ./gradlew build deployModl

For detailed setup instructions, see our Getting Started Guide.

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📝 License

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