Magicnode

A visual plugin-based platform to create and publish AI-powered micro applications

🚀 Quick Start • 📖 Documentation • 🤝 Contributing • 📄 License

A visual plugin-based platform to create and publish AI-powered micro applications. Build, configure, and deploy AI workflows with an intuitive drag-and-drop interface.

✨ Demo

Live Demo: Try Magicnode

What you can build:

📝 Content Generators: Blog posts, social media content, product descriptions
🔄 Data Processors: PDF analyzers, text summarizers, file converters
🤖 AI Assistants: Chatbots, Q&A systems, automated workflows
📊 Business Tools: Report generators, email templates, form builders

🚀 Features

Visual App Builder: Drag-and-drop interface for creating AI-powered applications
Plugin System: Extensible plugin architecture for AI services
File Processing: Support for PDF, images, and text files
Real-time Preview: See your app in action before publishing
Published Apps: Share your apps with unique URLs
Gallery: Browse and discover community-created apps

🏗️ Architecture

Magicnode follows a modern, scalable architecture with clear separation of concerns:

Server-Side (Node.js/Express)

server/
├── config/           # Configuration management
├── controllers/      # Business logic controllers
├── middleware/       # Express middleware
├── routes/          # API route definitions
├── services/        # External service integrations
├── utils/           # Utility functions
├── validators/      # Data validation schemas
└── index.ts         # Server entry point

Client-Side (React/TypeScript)

client/
├── src/
│   ├── components/  # Reusable UI components
│   ├── hooks/       # Custom React hooks
│   ├── lib/         # Utilities and API client
│   ├── pages/       # Page components
│   └── types/       # TypeScript type definitions

Shared

shared/
└── schema.ts        # Shared type definitions

🛠️ Tech Stack

Backend

Node.js with Express.js
TypeScript for type safety
MongoDB with MongoDB Driver
OpenAI API for AI services
Multer for file uploads
Zod for validation
Drizzle ORM for database operations

Frontend

React 18 with TypeScript
Vite for fast development
Tailwind CSS for styling
Radix UI for accessible components
React Query for data fetching
Wouter for routing
Framer Motion for animations

📖 Documentation

📚 Full Documentation - Complete setup and usage guide
🚀 Quick Start Guide - Get up and running in 5 minutes
🔧 Analytics Setup - Optional analytics configuration
🐳 Deployment Guide - Production deployment with Docker
🤝 Contributing Guide - How to contribute to the project
🔒 Privacy Policy - Data handling and privacy information

📦 Installation

Prerequisites

Node.js 18+ and npm
MongoDB (local or cloud)
OpenAI API Key (for AI features)

Quick Start

Clone the repository

git clone https://github.com/magicnode-open/magicnode-core.git
cd magicnode

Install dependencies

# Install root dependencies
npm install

# Install client dependencies
cd client && npm install

Set up environment variables

cp .env.example .env

Configure the following variables:

# Database
DATABASE_URL=your_mongodb_connection_string

# OpenAI
OPENAI_API_KEY=your_openai_api_key

# Server
PORT=8080
NODE_ENV=development

# Session
SESSION_SECRET=your_session_secret

# Analytics (Optional)
VITE_GA4_MEASUREMENT_ID=G-XXXXXXXXXX

Start the development server

# Start both client and server
npm run dev

# Or start them separately
npm run dev:server  # Server only
npm run dev:client  # Client only

🚀 Available Scripts

Root Package

npm run dev - Start development server
npm run build - Build for production
npm run start - Start production server
npm run db:push - Push database schema
npm run db:generate - Generate database migrations
npm run lint - Run ESLint
npm run type-check - Run TypeScript type checking

Client Package

npm run dev - Start Vite dev server
npm run build - Build client for production
npm run preview - Preview production build

📁 Project Structure

magicnode/
├── client/                 # React frontend
│   ├── src/
│   │   ├── components/     # UI components
│   │   ├── hooks/         # Custom hooks
│   │   ├── lib/           # Utilities
│   │   ├── pages/         # Page components
│   │   └── types/         # TypeScript types
│   └── package.json
├── server/                # Express backend
│   ├── config/           # Configuration
│   ├── controllers/      # Business logic
│   ├── middleware/       # Express middleware
│   ├── routes/          # API routes
│   ├── services/        # External services
│   ├── utils/           # Utilities
│   ├── validators/      # Validation schemas
│   └── index.ts         # Server entry
├── shared/               # Shared types
├── uploads/              # File uploads (gitignored)
└── package.json

🔧 Development

Adding New Plugins

Create plugin component in client/src/components/Plugins/
Add plugin type to client/src/types/app.ts
Implement server-side logic in server/controllers/appController.ts
Update validation schemas in server/validators/appValidators.ts

API Endpoints

GET /api/apps - Get all apps
POST /api/apps - Create new app
GET /api/apps/:id - Get app by ID
PUT /api/apps/:id - Update app
DELETE /api/apps/:id - Delete app
POST /api/apps/:id/execute - Execute app
GET /api/published/:slug - Get published app

Database Schema

The app uses MongoDB with the following collections:

microapp - App configurations and metadata
appexecution - App execution history
user - User accounts (future feature)

📊 Analytics (Optional)

Magicnode includes optional analytics tracking. See ANALYTICS_SETUP.md for detailed setup instructions.

Key Points:

✅ Completely Optional - App works without analytics
✅ Privacy-First - No data sent to original developers
✅ Your Data - Analytics go to your own Google Analytics account
✅ Configurable - Enable/disable specific tracking events

🚀 Deployment

Production Build

npm run build
npm start

Environment Variables for Production

Set NODE_ENV=production
Configure production database URL
Set secure session secret
Configure CORS origins
(Optional) Set up analytics tracking

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to get started.

Quick Start for Contributors

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Add tests if applicable
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Please read our Code of Conduct before contributing.

📊 Project Status

Current Status: ✅ Production Ready • Version: 1.0.0 • License: Sustainable Use

📄 License

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

License Summary

Use Case	Allowed	Notes
🏠 Personal Use	✅	Free for personal projects
🎓 Educational Use	✅	Free for learning and teaching
🏢 Internal Business	✅	Free for internal company use
💰 Commercial Services	❌	Not allowed for paid services
📦 Commercial Distribution	❌	Not allowed for commercial products

For commercial licensing inquiries, please contact the maintainers.

This license ensures the software remains freely available for learning and personal projects while protecting against commercial exploitation.

🗺️ Roadmap

Upcoming Features

Plugin Marketplace - Community-contributed plugins
Team Collaboration - Multi-user app development
API Integrations - Connect to external services
Mobile App - Native mobile applications
Advanced Analytics - Detailed usage insights

In Progress

Performance Optimization - Faster app execution
Enhanced Security - Additional security measures
Documentation - Comprehensive guides and tutorials

🆘 Support

Getting Help

Resource	Description
🐛 Bug Reports	Create an issue
💡 Feature Requests	Create an issue
💬 Community	GitHub Discussions
📧 Contact	Email support

Common Issues

Installation problems? Check the Quick Start Guide
Deployment issues? See the Deployment Guide
Analytics not working? Review Analytics Setup
Need help contributing? Read the Contributing Guide

Made with ❤️ by the Magicnode team

⭐ Star this repo • 🐛 Report a bug • 💡 Request a feature

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
client		client
scripts		scripts
server		server
shared		shared
.dockerignore		.dockerignore
.gitignore		.gitignore
ANALYTICS_SETUP.md		ANALYTICS_SETUP.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
EC2-SETUP.md		EC2-SETUP.md
EMAIL_SETUP.md		EMAIL_SETUP.md
LICENSE		LICENSE
PRIVACY.md		PRIVACY.md
PRODUCTION-SECURITY.md		PRODUCTION-SECURITY.md
README-DEPLOYMENT.md		README-DEPLOYMENT.md
README.md		README.md
components.json		components.json
deploy-ec2.sh		deploy-ec2.sh
deploy-production.sh		deploy-production.sh
deploy.sh		deploy.sh
docker-compose.production.yml		docker-compose.production.yml
docker-compose.yml		docker-compose.yml
drizzle.config.ts		drizzle.config.ts
env.example		env.example
env.production.example		env.production.example
nginx.conf		nginx.conf
nginx.production.conf		nginx.production.conf
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js
tailwind.config.ts		tailwind.config.ts
tsconfig.json		tsconfig.json
vite.config.ts		vite.config.ts

License

magicnode-open/magicnode-core

Folders and files

Latest commit

History

Repository files navigation