data-primals-engine

data-primals-engine is a powerful and flexible Node.js backend framework designed to accelerate the development of complex data-driven applications. Built on Express.js and MongoDB, it provides a solid foundation so you can focus on what makes your application unique.

Whether you're building a CRM, e-commerce site, CMS, or SaaS platform, data-primals-engine provides the strong foundations so you can focus on what makes your application unique.

---

---

🚀 Key Features

• Visual Data Modeling: Define and update schemas using a powerful UI Model Creator, or directly with JSON. No migrations required.
• Custom API Endpoints: Create server-side logic and new API endpoints directly from the UI in a secure, sandboxed environment.
• Automation Workflows: Trigger complex actions based on data events (create, update, delete) or schedules (cron).
• Advanced Querying & Aggregation: Go beyond simple filters with a visual Condition Builder, deep relation expansion, complex lookups, and dynamic calculated fields.
• Rich UI Data Views: Ready-to-use React components to display your data, including a powerful and configurable Data Table, a Kanban board, and a Calendar view.
• Integrated Backup & Restore: Secure, encrypted user data backups with rotation policies, supporting both local and AWS S3 storage.
• Automatic Data Auditing: Automatically tracks all changes (create, update, delete) for every record, providing a complete version history for auditing and traceability.
• Event-Driven & Extensible: A core event system allows for deep customization and the easy creation of new modules or plugins.
• Authentication & Authorization: Robust role-based access control (RBAC) and pluggable user providers.
• Built-in File Management: Handle file uploads seamlessly with integrated support for AWS S3 storage.
• 🧠 AI Integration: Natively supports OpenAI, DeepSeek and Google Gemini models via LangChain for content generation, analysis, and more.
• 🌐 Internationalization (i18n): Fully supports multilingual interfaces and user-specific translated data.
• 📦 Starter Packs: Quickly bootstrap applications with pre-built data packs for CRM, e-commerce, and more.
• 📄Auto-Generated API Documentation: Interactive API documentation available via the interface or at /api-docs.

🌟 Why Choose data-primals-engine?

• Zero Boilerplate: Focus on your business logic, not infrastructure
• Scalability: Architecture designed for rapidly growing applications
• Modularity: Enable/disable features as needed
• Batteries Included: Everything you need to get started quickly
• Proven Performance: Handles 50k+ documents efficiently
• AI Ready: Built-in LangChain integration for main providers (OpenAI,Gemini,Anthropic,DeepSeek)

---

📊 Proven Performance

The engine has been rigorously tested to ensure stability and scalability. Load tests simulating complex, multi-step user journeys (including model creation, data import, and API interactions) show excellent results:

• Zero Failures: 100% success rate under sustained concurrent load.
• Excellent Responsiveness: Median response times as low as 15-30ms.
• Linear Scaling: Predictable performance as user load increases.

For detailed reports, see the Performance Testing Documentation.

---

⚙️ Requirements

• Node.js ≥ 20
• MongoDB (local or remote), see installation guide
• NPM or Yarn

---

⚡ Quick Start

1. Prerequisites

• Node.js ≥ 20
• MongoDB (local or remote)

check

# Verify required versions
node -v # Must show ≥ v20
mongod --version # Must be installed

2. Installation

npm i data-primals-engine

or

git clone https://github.com/anonympins/data-primals-engine.git
cd data-primals-engine
npm install

3. Configuration

Create a .env file in the project root to configure the connection to your database :

MONGO_DB_URL=mongodb://127.0.0.1:27017/my_database
JWT_SECRET=a_long_and_random_secret

To discover all available environment variables (AWS, SMTP, AI, etc.), consult the configuration documentation.

4. Launch

# Development mode with automatic reloading
npm run devserver

# Production mode
npm run server

By default, the application is available at http://localhost:7633.

---

🧭 Explore the Platform

Discover the core features to get started building and managing your data. Link to the official documentation: https://data.primals.net/en/documentation/

• 🧠 Core Concepts: Explore the fundamentals of data modeling
• 🔌 Custom API Endpoints: Create dynamic HTTP routes directly from the backend
• 🏗️ Data Models: Structure your information.
• 🗃️ Data Management: Create, read, update, and delete your entries.
• 📊 Views (Table, Kanban): Visualize your data in different ways. (Page to be created)
• 📈 Dashboards, KPIs, and Charts: Track your key metrics.
• 👥 Users: Manage access to the platform.
• 🔐 Roles and Permissions: Define who can see and do what.
• ⚙️ Automation with Workflows: Create automated processes.

🔌 Integrate with your tools

Connect the platform to your external applications and services via our API.

• 📡 API Requests: The basics for interacting with the REST API.
• 🚀 Advanced Requests: Filters, sorts, projections, and more.
• 📦 Bulk Operations: Perform operations on large volumes of data.

🧩 Extend Capabilities

Go further by developing your own features and business logic.

• ⚡ Event System: React to events in real time. (Page to create)
• 🧠 Advanced Workflows: Create complex logic with custom scripts. (Page to create)
• 📦 Modules: Package and share your developments. (Page to create)
• ❤️ Contribute to the project (CONTRIBUTING.md): Join the developer community.

💻 For Developers

Essential tools for a seamless development experience.

• 📖 Explore the API with Swagger: Test API access points directly from your browser.
• 📮 Postman Collection: Import our collection to start querying in just a few clicks.

🤝 Contribution

Contributions are welcome! Check out the open issues to get started.

---

📄 License

Distributed under the MIT License. See the LICENSE file.