diff --git a/README.md b/README.md index d20c5d4..58a6a5f 100644 --- a/README.md +++ b/README.md @@ -1,507 +1,55 @@ -# FlowState Pro by Uriesmooth +# FlowState Pro -[](LICENSE) -[](https://github.com/uriesmooth) -[](https://nodejs.org) -[](https://prettier.io) +**Modular visual flow platform for teams that ship fast.** -**FlowState Pro** is a modular flow platform built for teams that ship fast. Build, connect, and deploy intelligent pipelines in minutes using a visual composer, with the flexibility to drop into custom code anytime. Scale easily, stay secure, and streamline your workflow seamlessly. +Build, connect, and deploy intelligent pipelines in minutes using a visual composer โ with full **NVIDIA GPU acceleration**, TensorRT optimization, and real-time vision capabilities. -๐ **Live Demo:** [wooden-slick-flow-pro.base44.app](https://wooden-slick-flow-pro.base44.app) +๐ **Website:** [uriesmooth.online](https://uriesmooth.online) +๐ฆ **Organization:** [UriesmoothTech](https://github.com/UriesmoothTech) --- -## Table of Contents +## Features -- [Features](#-features) -- [Quick Start](#-quick-start) -- [Documentation](#-documentation) -- [Project Structure](#๏ธ-project-structure) -- [Tech Stack](#๏ธ-tech-stack) -- [Usage Examples](#-usage-examples) -- [Testing](#-testing) -- [Contributing](#-contributing) -- [Support](#-support) -- [License](#-license) +- Visual flow composer +- Modular node-based pipelines +- Full **NVIDIA GPU** support (CUDA) +- **TensorRT** optimization for high-performance inference +- Real-time **Body โข Reaction โข Emotion Tracking** +- Easy local and containerized deployment --- -## โจ Features +## GPU Acceleration -### Core Capabilities -- **Visual Composer** - Drag-and-drop pipeline builder with intuitive UI -- **Modular Architecture** - Reusable components for rapid development -- **Custom Code Integration** - Drop into custom JavaScript/Python anytime -- **Team Collaboration** - Real-time collaboration for distributed teams -- **Scalable Infrastructure** - Handle millions of pipeline executions +FlowState Pro is built to take full advantage of NVIDIA GPUs. -### Enterprise Features -- **Enterprise Security** - Built-in authentication, encryption, and compliance -- **Rich Integrations** - Connect with 100+ third-party services -- **API-First Design** - Powerful REST and GraphQL APIs -- **Advanced Analytics** - Monitor pipelines and execution metrics -- **Multi-tenant Support** - Isolate teams and organizations +- Native CUDA support +- Optimized for desktop and professional NVIDIA graphics cards +- TensorRT engine support for faster AI inference +- Ready for real-time computer vision workloads -### Developer Experience -- **No-Code & Low-Code** - Visual builder with custom code escape hatch -- **Pre-built Nodes** - 50+ ready-to-use components -- **Node Library** - Create and share custom nodes -- **Version Control** - Track changes and rollback easily -- **Local Development** - SDK for local testing and development +### Requirements +- NVIDIA GPU (RTX series recommended) +- Latest NVIDIA drivers +- NVIDIA Container Toolkit (for Docker) --- -## ๐ Quick Start +## Real-Time Vision -### Prerequisites -- **Node.js** 18.0.0 or higher -- **npm** 9.0.0 or higher -- **Git** for version control -- Optional: Docker for containerized deployment +FlowState Pro supports advanced vision capabilities: -### Installation +- **Body Movement Tracking** โ Pose and gesture recognition +- **Reaction Detection** โ Real-time response analysis +- **Emotion Recognition** โ Facial and affective state detection -#### 1. Clone the Repository -```bash -git clone https://github.com/uriesmooth/Uriesmooth-.git -cd Uriesmooth- -``` - -#### 2. Install Dependencies -```bash -npm install -``` - -#### 3. Configure Environment -```bash -# Copy the example environment file -cp .env.example .env - -# Edit .env with your configuration -# nano .env -``` - -#### 4. Start Development Server -```bash -npm run dev -``` - -#### 5. Access the Application -Open your browser and navigate to: -``` -http://localhost:3000 -``` - -### First Pipeline - -Once you're logged in: - -1. Click **"Create Pipeline"** -2. Add nodes by dragging from the sidebar -3. Connect nodes to create your flow -4. Click **"Deploy"** to activate -5. Monitor execution in the **Dashboard** - ---- - -## ๐ Documentation - -### Getting Started Guides -- [Installation Guide](docs/installation.md) - Detailed setup instructions -- [Quick Start Tutorial](docs/quickstart.md) - Build your first pipeline in 5 minutes -- [Configuration Guide](docs/configuration.md) - Environment setup and customization - -### Core Concepts -- [Pipelines](docs/concepts/pipelines.md) - Understand pipeline structure -- [Flows & Nodes](docs/concepts/flows.md) - Core building blocks -- [Triggers](docs/concepts/triggers.md) - How to trigger pipelines -- [Actions](docs/concepts/actions.md) - Execute tasks and integrations - -### API Reference -- [REST API](docs/api/rest.md) - RESTful API documentation -- [GraphQL API](docs/api/graphql.md) - GraphQL schema and queries -- [Webhooks](docs/api/webhooks.md) - Incoming and outgoing webhooks -- [SDK Reference](docs/api/sdk.md) - JavaScript/TypeScript SDK - -### Advanced Topics -- [Custom Nodes](docs/advanced/custom-nodes.md) - Build your own nodes -- [Deployment Strategies](docs/advanced/deployment.md) - Production deployment -- [Performance Optimization](docs/advanced/performance.md) - Scaling pipelines -- [Security Best Practices](docs/advanced/security.md) - Security hardening - -### Examples -- [Data Processing](examples/data-processing.md) - ETL pipelines -- [Webhook Integration](examples/webhooks.md) - Real-time integrations -- [Scheduled Tasks](examples/scheduled-tasks.md) - Cron-style scheduling -- [Error Handling](examples/error-handling.md) - Robust error management +These features are accelerated with NVIDIA GPU + TensorRT. --- -## ๐๏ธ Project Structure - -``` -Uriesmooth-/ -โโโ src/ # Source code -โ โโโ components/ # Reusable UI components -โ โ โโโ pipeline/ -โ โ โโโ nodes/ -โ โ โโโ canvas/ -โ โ โโโ shared/ -โ โโโ pages/ # Application pages -โ โ โโโ dashboard/ -โ โ โโโ pipelines/ -โ โ โโโ settings/ -โ โ โโโ auth/ -โ โโโ api/ # API routes & handlers -โ โ โโโ auth/ -โ โ โโโ pipelines/ -โ โ โโโ executions/ -โ โ โโโ integrations/ -โ โโโ services/ # Business logic -โ โ โโโ pipeline.service.js -โ โ โโโ execution.service.js -โ โ โโโ integration.service.js -โ โโโ utils/ # Utility functions -โ โ โโโ validators/ -โ โ โโโ formatters/ -โ โ โโโ helpers/ -โ โโโ styles/ # Global styles -โ โ โโโ variables.scss -โ โ โโโ globals.scss -โ โ โโโ themes/ -โ โโโ config/ # Configuration -โ โ โโโ database.js -โ โ โโโ redis.js -โ โ โโโ logger.js -โ โโโ middleware/ # Express middleware -โ โโโ auth.js -โ โโโ errorHandler.js -โ โโโ requestLogger.js -โ -โโโ public/ # Static assets -โ โโโ images/ -โ โโโ icons/ -โ โโโ fonts/ -โ -โโโ docs/ # Documentation -โ โโโ concepts/ -โ โโโ api/ -โ โโโ advanced/ -โ โโโ examples/ -โ -โโโ tests/ # Test suites -โ โโโ unit/ -โ โโโ integration/ -โ โโโ e2e/ -โ -โโโ .github/ # GitHub configuration -โ โโโ workflows/ # CI/CD pipelines -โ โโโ ISSUE_TEMPLATE/ -โ โโโ PULL_REQUEST_TEMPLATE/ -โ -โโโ config/ # Configuration files -โ โโโ webpack.config.js -โ โโโ jest.config.js -โ โโโ eslint.config.js -โ -โโโ docker/ # Docker files -โ โโโ Dockerfile -โ โโโ docker-compose.yml -โ โโโ .dockerignore -โ -โโโ k8s/ # Kubernetes manifests -โ โโโ deployment.yaml -โ โโโ service.yaml -โ โโโ configmap.yaml -โ -โโโ .env.example # Environment template -โโโ .gitignore # Git ignore rules -โโโ .dockerignore # Docker ignore rules -โโโ package.json # Dependencies & scripts -โโโ package-lock.json # Locked versions -โโโ Dockerfile # Container image -โโโ docker-compose.yml # Local development compose -โโโ LICENSE # MIT License -โโโ CONTRIBUTING.md # Contribution guidelines -โโโ SECURITY.md # Security policy -โโโ README.md # This file -``` - ---- - -## ๐ ๏ธ Tech Stack - -### Frontend -| Technology | Purpose | -|-----------|---------| -| **React 18** | UI Framework | -| **Redux Toolkit** | State Management | -| **Tailwind CSS** | Styling | -| **React Query** | Data Fetching | -| **React Flow** | Node-based Editor | -| **TypeScript** | Type Safety | - -### Backend -| Technology | Purpose | -|-----------|---------| -| **Node.js** | Runtime | -| **Express.js** | Web Framework | -| **PostgreSQL** | Primary Database | -| **Redis** | Caching & Queue | -| **Socket.io** | Real-time Communication | -| **JWT** | Authentication | - -### DevOps & Tools -| Technology | Purpose | -|-----------|---------| -| **Docker** | Containerization | -| **Kubernetes** | Orchestration | -| **GitHub Actions** | CI/CD | -| **Jest** | Testing | -| **ESLint** | Linting | -| **Prettier** | Code Formatting | - ---- - -## ๐ Usage Examples - -### Example 1: Create a Data Processing Pipeline - -```javascript -import { FlowState } from '@flowstate/sdk'; - -const flowstate = new FlowState({ - apiKey: 'your-api-key', - baseUrl: 'https://api.flowstate.io' -}); - -// Create a pipeline -const pipeline = await flowstate.pipelines.create({ - name: 'Daily Data Sync', - description: 'Sync data from API to database', - - nodes: [ - { - id: 'webhook-trigger', - type: 'trigger', - config: { - event: 'webhook', - path: '/data-sync' - } - }, - { - id: 'fetch-data', - type: 'http', - config: { - method: 'GET', - url: 'https://api.example.com/data', - headers: { 'Authorization': 'Bearer token' } - } - }, - { - id: 'transform', - type: 'transform', - config: { - script: ` - return data.map(item => ({ - id: item.id, - name: item.title, - updated_at: new Date() - })); - ` - } - }, - { - id: 'save-to-db', - type: 'database', - config: { - provider: 'postgresql', - table: 'data_sync', - action: 'upsert' - } - } - ], - - connections: [ - { from: 'webhook-trigger', to: 'fetch-data' }, - { from: 'fetch-data', to: 'transform' }, - { from: 'transform', to: 'save-to-db' } - ] -}); - -console.log('Pipeline created:', pipeline.id); -``` - -### Example 2: Deploy to Docker +## Quick Start ```bash -# Build the Docker image -docker build -t flowstate-pro:v1.0.0 . - -# Run the container -docker run -p 3000:3000 \ - -e NODE_ENV=production \ - -e DATABASE_URL=postgresql://user:pass@host:5432/db \ - -e JWT_SECRET=your-secret-key \ - flowstate-pro:v1.0.0 - -# Push to Docker Hub -docker login -docker tag flowstate-pro:v1.0.0 yourusername/flowstate-pro:v1.0.0 -docker push yourusername/flowstate-pro:v1.0.0 -``` - -### Example 3: Deploy to Kubernetes - -```bash -# Create namespace -kubectl create namespace flowstate - -# Deploy application -kubectl apply -f k8s/deployment.yaml -n flowstate -kubectl apply -f k8s/service.yaml -n flowstate - -# Check status -kubectl get pods -n flowstate -kubectl logs -f deployment/flowstate-pro -n flowstate -``` - ---- - -## ๐งช Testing - -### Run Tests -```bash -# Run all tests with coverage -npm test - -# Run tests in watch mode -npm run test:watch - -# Run specific test file -npm test -- tests/api.test.js - -# Run only unit tests -npm test -- --testPathPattern=unit - -# Generate coverage report -npm run test:coverage -``` - -### Test Structure -``` -tests/ -โโโ unit/ # Component and function tests -โโโ integration/ # API and service tests -โโโ e2e/ # End-to-end tests -``` - ---- - -## ๐ค Contributing - -We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for details on: - -- Code style guidelines -- Testing requirements -- Pull request process -- Commit message conventions -- Development setup - -### Quick Start for Contributors - -```bash -# 1. Fork the repository -git clone https://github.com/yourusername/Uriesmooth-.git -cd Uriesmooth- - -# 2. Create a feature branch -git checkout -b feature/amazing-feature - -# 3. Make changes and commit -git add . -git commit -m "feat: Add amazing feature" - -# 4. Push and create PR -git push origin feature/amazing-feature -``` - ---- - -## ๐ Bug Reports & Feature Requests - -- **๐ Found a bug?** [Create an Issue](https://github.com/uriesmooth/Uriesmooth-/issues/new?labels=bug) -- **โจ Have an idea?** [Request a Feature](https://github.com/uriesmooth/Uriesmooth-/discussions/new) - ---- - -## ๐ Roadmap - -### Q3 2024 -- [ ] Advanced analytics dashboard -- [ ] ML-powered optimization suggestions -- [ ] Custom node marketplace - -### Q4 2024 -- [ ] Mobile app for iOS/Android -- [ ] Enterprise SSO integration -- [ ] Advanced audit logging - -### 2025 -- [ ] Real-time collaboration v2 -- [ ] AI assistant for pipeline building -- [ ] Advanced workflow templates - -[View Full Roadmap โ](https://github.com/uriesmooth/Uriesmooth-/projects) - ---- - -## ๐ Support - -- **๐ Documentation:** [docs/](docs/) -- **๐ฌ Community Chat:** [GitHub Discussions](https://github.com/uriesmooth/Uriesmooth-/discussions) -- **๐ Issues:** [GitHub Issues](https://github.com/uriesmooth/Uriesmooth-/issues) -- **๐ง Email:** support@flowstatepro.io -- **๐ฆ Twitter:** [@flowstatepro](https://twitter.com/flowstatepro) - ---- - -## ๐ License - -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. - ---- - -## ๐ Acknowledgments - -- Built with โค๏ธ for teams that ship fast -- Inspired by modern workflow automation platforms -- Thanks to all [contributors](https://github.com/uriesmooth/Uriesmooth-/graphs/contributors) -- Special thanks to the open-source community - ---- - -## ๐ Project Stats - - - - - - ---- - -## Security & Privacy - -- ๐ [Security Policy](SECURITY.md) - Responsible disclosure -- ๐ [Privacy Policy](docs/privacy.md) - Data handling -- ๐ก๏ธ [Compliance](docs/compliance.md) - GDPR, SOC 2, ISO 27001 - ---- - -