Skip to content

stan-smith/FossFLOW

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FossFLOW - Isometric Diagramming Tool fossflow

English | 简体中文 | Español | Português | Français | हिन्दी | বাংলা | Русский

stan-smith%2FFossFLOW | Trendshift

Hey! Stan here, if you've used FossFLOW and it's helped you, I'd really appreciate if you could donate something small :) I work full time, and finding the time to work on this project is challenging enough. If you've had a feature that I've implemented for you, or fixed a bug it'd be great if you could :) if not, that's not a problem, this software will always remain free!

Also! If you haven't yet, please check out the underlying library this is built on by @markmanx I truly stand on the shoulders of a giant here 🫡

ko-fi

Buy Me A Coffee

Thanks,

-Stan

Try it online

Go to --> https://stan-smith.github.io/FossFLOW/ <--


FossFLOW is a powerful, open-source Progressive Web App (PWA) for creating beautiful isometric diagrams. Built with React and the Isoflow (Now forked and published to NPM as fossflow) library, it runs entirely in your browser with offline support.

Screenshot_20250630_160954

  • 📝 FOSSFLOW_TODO.md - Current issues and roadmap with codebase mappings, most gripes are with the isoflow library itself.
  • 🤝 CONTRIBUTING.md - How to contribute to the project.

Performance updates

  • Reduced frame refresh delay, should look much smoother now

Multilingual Support

  • 8 Languages Supported - Full interface translation in English, Chinese (Simplified), Spanish, Portuguese (Brazilian), French, Hindi, Bengali, and Russian
  • Language Selector - Easy-to-use language switcher in the app header
  • Complete Translation - All menus, dialogs, settings, tooltips, and help content translated
  • Locale-Aware - Automatically detects and remembers your language preference

Improved Connector Tool

  • Click-based Creation - New default mode: click first node, then second node to connect
  • Drag Mode Option - Original drag-and-drop still available via settings
  • Mode Selection - Switch between click and drag modes in Settings → Connectors tab
  • Better Reliability - Click mode provides more predictable connection creation

🐳 Quick Deploy with Docker

# Using Docker Compose (recommended - includes persistent storage)
docker compose up

# Or run directly from Docker Hub with persistent storage
docker run -p 80:80 -v $(pwd)/diagrams:/data/diagrams stnsmith/fossflow:latest

Server storage is enabled by default in Docker. Your diagrams will be saved to ./diagrams on the host.

To disable server storage, set ENABLE_SERVER_STORAGE=false:

docker run -p 80:80 -e ENABLE_SERVER_STORAGE=false stnsmith/fossflow:latest

Quick Start (Local Development)

# Clone the repository
git clone https://github.com/stan-smith/FossFLOW
cd FossFLOW

# Install dependencies
npm install

# Build the library (required first time)
npm run build:lib

# Start development server
npm run dev

Open http://localhost:3000 in your browser.

Monorepo Structure

This is a monorepo containing two packages:

  • packages/fossflow-lib - React component library for drawing network diagrams (built with Webpack)
  • packages/fossflow-app - Progressive Web App which wraps the lib and presents it (built with RSBuild)

Development Commands

# Development
npm run dev          # Start app development server
npm run dev:lib      # Watch mode for library development

# Building
npm run build        # Build both library and app
npm run build:lib    # Build library only
npm run build:app    # Build app only

# Testing & Linting
npm test             # Run unit tests
npm run lint         # Check for linting errors

# E2E Tests (Selenium)
cd e2e-tests
./run-tests.sh       # Run end-to-end tests (requires Docker & Python)

# Publishing
npm run publish:lib  # Publish library to npm

How to Use

Creating Diagrams

  1. Add Items:

    • Press the "+" button on the top right menu, the library of components will appear on the left
    • Drag and drop components from the library onto the canvas
    • Or right-click on the grid and select "Add node"
  2. Connect Items:

    • Select the Connector tool (press 'C' or click connector icon)
    • Click mode (default): Click first node, then click second node
    • Drag mode (optional): Click and drag from first to second node
    • Switch modes in Settings → Connectors tab
  3. Save Your Work:

    • Quick Save - Saves to browser session
    • Export - Download as JSON file
    • Import - Load from JSON file

Storage Options

  • Session Storage: Temporary saves cleared when browser closes
  • Export/Import: Permanent storage as JSON files
  • Auto-Save: Automatically saves changes every 5 seconds to session

Contributing

We welcome contributions! Please see CONTRIBUTORS.md for guidelines.

Documentation

License

MIT

About

Make beautiful isometric infrastructure diagrams

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project