Getting Started with NodeBox

Welcome to NodeBox! This guide will help you set up NodeBox and run your first automation in minutes.

What is NodeBox?

NodeBox is an open-source visual automation platform powered by Python and local AI (Ollama). With NodeBox, you can design, run, and manage automations on your own machine—no cloud required, no API costs. NodeBox is ideal for:

  • Automating repetitive tasks
  • Integrating local AI models
  • Building custom Python workflows
  • Experimenting with node-based logic

Key Features

  • Python-native nodes for maximum flexibility
  • Drag-and-drop visual editor
  • Local AI integration via Ollama
  • Cross-platform: Windows, macOS, Linux
  • Open-source and community-driven

Installation

  1. Clone the repository: 
    git clone https://github.com/shreyansh-shankar/Nodebox.git
  2. Navigate to the project folder: 
    cd Nodebox
  3. Install dependencies: 
    pip install -r requirements.txt
  4. Start Ollama (if using AI nodes): 
    ollama serve

Running NodeBox

  1. Run the main application: 
    python main.py
  2. NodeBox will launch its interface. You can now create and run automations!

Your First Automation Node

Coming Soon...

Need Help?

Check the Docs, FAQ for support.

Project Workflow

  1. Open NodeBox and explore the visual editor.
  2. Drag nodes from the palette onto the canvas.
  3. Connect nodes to define your workflow.
  4. Configure node properties and parameters.
  5. Click Run to execute your automation.

Troubleshooting & Tips

  • Make sure Python and Ollama are installed and added to your PATH.
  • If you encounter issues, check the FAQ or Docs.
  • For dependency errors, try updating pip and reinstalling requirements.
  • Use the GitHub Issues page for bug reports.

Hacktoberfest & Contributing

NodeBox welcomes contributions! If you're participating in Hacktoberfest, check out the How to Contribute page for guidelines and workflow. All contributors are encouraged to:

Need Help?

Check the Docs, FAQ, or join our GitHub for support.