Skip to content

Claritrie/Frezgi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

14 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Banner Image

Frezgi

Untangling Problems with Accessible Argument Mapping

License: MIT Live Demo Contributions Welcome

Overview

Frezgi is a visual argument mapping tool that helps you map out complex arguments and decisions using an intuitive, interactive interface. Create argument tries with supporting, opposing, and exploring nodes to better understand problems and make informed choices.

Preview

โœจ Features

  • Visual Argument Mapping: Create interactive argument tries with drag-and-drop nodes
  • Multiple Node Types: Support for supporting (๐Ÿ‘), opposing (๐Ÿ‘Ž), and exploring (โœ‹) arguments
  • Customizable Colors: Personalize your argument maps with custom color schemes
  • No Registration Required: Start mapping arguments immediately

๐ŸŽฏ Use Cases

  • Personal Decisions: Career choices, major purchases, life changes
  • Business Planning: Project evaluations, strategic decisions, risk assessment
  • Academic Research: Argument analysis, thesis development, literature reviews
  • Team Collaboration: Group decision-making, brainstorming sessions

๐Ÿš€ Quick Start

Online (Recommended)

Visit frezgi.com to start using Frezgi immediately.

Local Development

  1. Clone the repository:

    git clone https://github.com/Claritrie/Frezgi.git
    cd Frezgi
  2. Serve locally:

    # Python 3
    python -m http.server 8000
    
    # Node.js
    npx http-server
    
    # PHP
    php -S localhost:8000
  3. Open in browser: Navigate to http://localhost:8000

๐ŸŽฎ How to Use

  1. Start with the main resolution - Double-click to edit the central question
  2. Add supporting arguments - Hover over any node and click ๐Ÿ‘
  3. Add opposing arguments - Hover over any node and click ๐Ÿ‘Ž
  4. Explore alternatives - Hover over any node and click โœ‹
  5. Drag to organize - Click and drag nodes to arrange your argument trie
  6. Customize colors - Use the color panel (hover left edge) to personalize

๐Ÿ—๏ธ Project Structure

Frezgi/
โ”œโ”€โ”€ index.html              # Main application
โ”œโ”€โ”€ assets/                 # Compiled Vue.js application
โ”‚   โ”œโ”€โ”€ index-*.js         # Application logic
โ”‚   โ””โ”€โ”€ index-*.css        # Styles
โ”œโ”€โ”€ docs/                   # Documentation
โ”‚   โ””โ”€โ”€ CONTRIBUTING.md     # Contribution guidelines
โ”œโ”€โ”€ README.md              # This file
โ””โ”€โ”€ LICENSE                # MIT License

๐Ÿ› ๏ธ Technology Stack

  • Frontend: Vue.js 3 (compiled to vanilla JS)
  • Styling: CSS3 with modern features
  • Deployment: GitHub Pages
  • License: MIT

๐Ÿค Contributing

We welcome contributions from developers of all skill levels! Whether you're fixing bugs, adding features, or improving documentation, your help makes Frezgi better.

Quick Contribution Guide

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“– Read the full Contributing Guide for detailed instructions.

Types of Contributions Needed

  • ๐Ÿ› Bug fixes - Help make Frezgi more reliable
  • โœจ New features - Expand argument mapping capabilities
  • ๐Ÿ“š Documentation - Improve guides and examples
  • ๐ŸŽจ UI/UX improvements - Enhance user experience
  • ๐ŸŒ Accessibility - Make Frezgi usable for everyone
  • ๐Ÿ”ง Performance - Optimize for better speed

๐Ÿ“‹ Roadmap

  • Export to PNG
  • Export to JSON/TRIE (rename as .trie file)
  • Import from JSON/TRIE
  • Toggling/Draggable Floating Legend (Show user color-to-stance correlations)
  • Toggle stance label names per line (because/but/however or Supporting/Opposing/Exploring, none, etc...)
  • Local Storage (Preserve your arguments with browser storage)
  • Undo/Redo functionality
  • Offline web-app (Tauri port)
  • Responsive Design (Works seamlessly on mobile devices too)
  • Export to PDF
  • Locking Mechanism
  • Keyboard shortcuts
  • Advanced templates
  • Collaborative editing?

See Issues for detailed feature requests and bug reports.

๐Ÿ› Bug Reports & Feature Requests

Found a bug or have an idea for improvement?

๐Ÿ“„ License

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

What this means:

  • โœ… Use for any purpose - Personal, commercial, educational
  • โœ… Modify and distribute - Create your own versions
  • โœ… Include in proprietary software - No copyleft restrictions
  • โœ… Sublicense - Integrate into larger projects
  • โš ๏ธ Attribution required - Must include copyright notice and license
  • โš ๏ธ No warranty - Software provided "as is"

Simple Summary:

You can do almost anything with this code, just keep the copyright notice and don't blame us if something goes wrong!

๐Ÿ™ Acknowledgments

๐Ÿ“ž Support

  • ๐Ÿ“– Documentation: Check the docs folder
  • ๐Ÿ’ฌ Discussions: Use GitHub Issues for questions
  • ๐Ÿ› Bug Reports: Use the bug report template
  • โœจ Feature Requests: Use the feature request template

Made with โค๏ธ for better argument mapping and decision-making

Star โญ this repository if Frezgi helps you map better arguments!

Configuration Notes

Asset Path Configuration

This project requires different asset path configurations depending on how you want to use it:

For GitHub Pages Deployment (Current Configuration)

The index.html file is currently configured for GitHub Pages deployment with absolute paths:

<script type="module" crossorigin src="/assets/index-BywTncqB.js"></script>
<link rel="stylesheet" crossorigin href="/assets/index-BfVVlJSu.css">

For Local/Offline Use

If you want to run this project locally or offline, you need to modify the asset paths in index.html to use relative paths:

<script type="module" crossorigin src="./assets/index-BywTncqB.js"></script>
<link rel="stylesheet" crossorigin href="./assets/index-BfVVlJSu.css">

Switching Between Configurations

  • For deployment: Use absolute paths (/assets/)
  • For local development: Use relative paths (./assets/)

About

Untangling Problems with Accessible Argument Mapping

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •