Skip to content

odtp-org/odtp-yaml-generator

Repository files navigation

ODTP YAML Generator

A browser-based tool for generating ODTP YAML configuration files. This tool runs entirely in your browser using Streamlit Lite (stlite), with no server required.

Features

  • Generate ODTP YAML files with a user-friendly interface
  • Add multiple tools, parameters, and other configurations
  • Download generated YAML files
  • Runs completely in the browser
  • No server required

Quick Start with Docker

  1. Clone the repository:

    git clone https://github.com/your-username/odtp-yaml-generator.git
    cd odtp-yaml-generator
  2. Start the server using Docker Compose:

    docker-compose up -d
  3. Open your browser and navigate to:

    http://localhost
    

Manual Setup

Prerequisites

  • Docker and Docker Compose
  • or any static file server

Local Development

Method 1: Using Docker

  1. Build and run with Docker Compose:

    docker-compose up --build
  2. For development with auto-reload:

    docker-compose up -d

Method 2: Using Python HTTP Server

  1. Run a simple HTTP server:

    python -m http.server 8000
  2. Open http://localhost:8000

Project Structure

  • index.html: Main entry point
  • streamlit_app.py: Streamlit Lite application
  • requirements.txt: Python dependencies
  • Dockerfile: Docker configuration
  • nginx.conf: NGINX server configuration
  • docker-compose.yml: Docker Compose configuration

Deployment

Using Docker (Recommended)

  1. Build the image:

    docker build -t odtp-yaml-generator .
  2. Run the container:

    docker run -d -p 80:80 odtp-yaml-generator

Manual Deployment

Copy the following files to your web server:

  • index.html
  • streamlit_app.py
  • requirements.txt

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

License

AGPL 3.0

Support

If you encounter any issues or have questions:

  1. Open an issue on GitHub
  2. Provide details about your problem
  3. Include steps to reproduce if applicable

About

Small app that helps to generate odtp compatible yaml files

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published