README.md

Nodebook.js

The next generation of interactive notebooks with reactive programming and live JavaScript execution.

The main Nodebook.js interface showcasing reactive code cells, rich outputs, and live data visualization

🚀 What is Nodebook.js?

Nodebook.js is a modern reactive notebook application that revolutionizes interactive computing. Unlike traditional notebooks, Nodebook.js features a reactive system where cells automatically update when their dependencies change, creating a truly live and dynamic environment for:

• 📊 Data Analysis & Visualization
• 🧪 Scientific Computing
• 📈 Financial Modeling
• 🤖 AI/ML Prototyping
• 📚 Educational Content
• 🛠️ Rapid Prototyping

✨ Key Features

🔬 Reactive Programming

Variables and computations automatically propagate changes throughout your notebook. When you update a value, all dependent cells re-execute automatically.

// Cell 1: Define a variable
exports.basePrice = 100;

// Cell 2: Automatically updates when basePrice changes
exports.totalPrice = basePrice * 1.08; // Tax included

⚡ Live JavaScript Execution

Full ES6+ JavaScript support with modern async/await, modules, and rich standard library access.

📊 Rich Data Visualization

Built-in support for popular visualization libraries:

• Plotly.js - Interactive charts and graphs
• D3.js - Custom data visualizations
• Chart.js - Beautiful charts
• DataFrames - Tabular data with danfo.js

Interactive charts and data tables rendered directly in notebook cells

📝 Enhanced Markdown

Dynamic markdown with variable interpolation, LaTeX math, and rich formatting.

The current price is ${{totalPrice}} (base: ${{basePrice}})

$$E = mc^2$$

🔧 Modular System

Easy access to popular libraries:

// Pre-loaded libraries
dfd.readCSV('data.csv').then(df => {
    output.table(df);
});

// TensorFlow for machine learning
const model = tf.sequential({...});

// Shell integration with zx
await $`ls -la`;

🤖 AI-Powered Development

• Generate code cells with AI assistance
• Smart code completions
• Intelligent error detection and suggestions

🎨 Modern Interface

• Clean, intuitive design
• Dark/light theme support
• Responsive layout
• Reading mode for presentations

🛠️ Installation & Setup

System Requirements

• Windows 10+ / macOS 10.14+ / Linux (Ubuntu 18.04+)
• Node.js 16+ (for development)
• 4GB RAM minimum, 8GB recommended
• 500MB disk space

Download

1. Visit the Releases page
2. Download the installer for your platform
3. Run the installer and follow the setup wizard

Development Setup

# Clone the repository
git clone https://github.com/gcannata/nodebook.js.git
cd nodebook.js

# Install dependencies
pnpm install

# Start development server
pnpm start

# Build for production
pnpm run make

📚 Documentation

📖 Complete Documentation

Access the full documentation or within the application:

• Press Ctrl/Cmd+, for instant help
• Click the 📖 icon in the toolbar
• Use "View Documentation" command

🎯 Quick Start Guides

• Code Cells Guide - JavaScript execution, modules, and outputs
• Markdown Cells - Rich text, LaTeX, and variable interpolation
• Formula System - Excel-like formulas with reactive updates
• Storage System - Data persistence and state management
• Module System - Using external libraries and packages

🔧 Advanced Features

• Static Code Cells - Manual execution for side effects
• Reading Mode - Presentation mode for sharing
• Async/Await Guide - Handling asynchronous operations

🎮 Quick Start

1. Create a New Notebook

   File → New Notebook (Ctrl+N)
   

2. Add Your First Code Cell

   const greeting = "Hello, Nodebook.js!";
   console.log(greeting);
   output(greeting);

3. Add a Markdown Cell

   # My First Notebook
   The greeting is: **{{greeting}}**

4. Execute and See Magic

   • Press Shift+Enter to run cells
   • Watch variables update across cells automatically
   • See rich outputs and interactive visualizations

Your first notebook showing reactive variables and rich outputs

🔧 Built With

• Electron - Cross-platform desktop app framework
• React - Modern UI library
• TypeScript - Type-safe JavaScript
• Vite - Fast build tool
• Tailwind CSS - Utility-first CSS framework
• CodeMirror - Advanced code editor
• Github Copilot - AI-powered code suggestions

🤝 Contributing

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

Development Workflow

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes and add tests
4. Commit: git commit -m 'Add amazing feature'
5. Push: git push origin feature/amazing-feature
6. Open a Pull Request

📄 License

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

🆘 Support

• Documentation: docs/
• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: gcannata@gmail.com

🙏 Acknowledgments

• Inspired by Jupyter Notebooks and Observable
• Thanks to all contributors and beta testers
• Built with amazing open-source technologies

---

Made with ❤️ by Gabriele Cannata