# Jumentix

> Jumentix is a software factory framework for building REST, realtime, and offline apps with shared contracts.

Site: https://jumentix-website.vercel.app
Docs index JSON: https://jumentix-website.vercel.app/docs-index.json

## Start here
- Getting started: https://jumentix-website.vercel.app/docs/jumentix/concepts/getting-started
- Concepts overview: https://jumentix-website.vercel.app/docs/jumentix/concepts/overview
- Architecture: https://jumentix-website.vercel.app/docs/jumentix/concepts/architecture

## Guides
- Run and Use the Service Manager: https://jumentix-website.vercel.app/docs/jumentix/guides/service-management
- Create a REST API: https://jumentix-website.vercel.app/docs/jumentix/guides/rest-api
- Create a Realtime API: https://jumentix-website.vercel.app/docs/jumentix/guides/realtime-api
- Create a SPA or Offline PWA: https://jumentix-website.vercel.app/docs/jumentix/guides/spa-pwa
- Create a Modular SaaS: https://jumentix-website.vercel.app/docs/jumentix/guides/saas-monolith
- Create a Microservices SaaS: https://jumentix-website.vercel.app/docs/jumentix/guides/saas-microservices
- Guides: https://jumentix-website.vercel.app/docs/jumentix/guides

## Packages
- Jumentix packages: https://jumentix-website.vercel.app/docs/jumentix/packages
- @jumentix/cana: https://jumentix-website.vercel.app/docs/jumentix/packages/cana
- Cana usage guide: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage
- Getting started with Cana: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/getting-started
- Schema and keys: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/schema-keys
- Reading, writing and bulk operations: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/crud-bulk
- Querying and plans: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/querying
- Transactions and change events: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/transactions-events
- Hooks and errors: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/hooks-errors
- Storage and crash recovery: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/storage-recovery
- Workers and testing: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/workers-testing
- API reference: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/usage/api-reference
- Cana with React Context API: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/react-context
- Cana with React Redux: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/react-redux
- Cana with Vue 3 and Pinia: https://jumentix-website.vercel.app/docs/jumentix/packages/cana/vue-pinia
- @jumentix/designer-core: https://jumentix-website.vercel.app/docs/jumentix/packages/designer-core
- designer-core usage: https://jumentix-website.vercel.app/docs/jumentix/packages/designer-core/usage
- @jumentix/key-value-storage: https://jumentix-website.vercel.app/docs/jumentix/packages/key-value-storage
- key-value-storage usage: https://jumentix-website.vercel.app/docs/jumentix/packages/key-value-storage/usage
- @jumentix/mutex-service: https://jumentix-website.vercel.app/docs/jumentix/packages/mutex-service
- mutex-service usage: https://jumentix-website.vercel.app/docs/jumentix/packages/mutex-service/usage
- @jumentix/message-mediator: https://jumentix-website.vercel.app/docs/jumentix/packages/message-mediator
- message-mediator usage: https://jumentix-website.vercel.app/docs/jumentix/packages/message-mediator/usage
- @jumentix/external-db-repositories: https://jumentix-website.vercel.app/docs/jumentix/packages/external-db-repositories
- @jumentix/external-persistence-core: https://jumentix-website.vercel.app/docs/jumentix/packages/external-persistence-core
- @jumentix/external-store-proxy: https://jumentix-website.vercel.app/docs/jumentix/packages/external-store-proxy
- @jumentix/persistence-contracts: https://jumentix-website.vercel.app/docs/jumentix/packages/persistence-contracts
- @jumentix/database-client-factory: https://jumentix-website.vercel.app/docs/jumentix/packages/database-client-factory
- @jumentix/shared-contracts: https://jumentix-website.vercel.app/docs/jumentix/packages/shared-contracts
- @jumentix/sdk-rest-client: https://jumentix-website.vercel.app/docs/jumentix/packages/sdk-rest-client
- @jumentix/sdk-websocket-client: https://jumentix-website.vercel.app/docs/jumentix/packages/sdk-websocket-client
- @jumentix/sdk-grpc-client: https://jumentix-website.vercel.app/docs/jumentix/packages/sdk-grpc-client
- @jumentix/adapter-runtime-bootstrap: https://jumentix-website.vercel.app/docs/jumentix/packages/adapter-runtime-bootstrap
- @jumentix/runtime-infra: https://jumentix-website.vercel.app/docs/jumentix/packages/runtime-infra
- @jumentix/cana-react: https://jumentix-website.vercel.app/docs/jumentix/packages/cana-react
- @jumentix/cana-vue: https://jumentix-website.vercel.app/docs/jumentix/packages/cana-vue

## Adapters
- Adonis.js Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/adonis-js
- AWS Lambda Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/aws-lambda
- Cloudflare Workers Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/cloudflare-workers
- Derby.js Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/derby-js
- Express Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/express
- Fastify Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/fastify
- Feathers Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/feathers
- LoopBack Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/loopback
- HTTP Adapters: https://jumentix-website.vercel.app/docs/jumentix/adapters/http
- Restify Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/restify
- Sails.js Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/sails-js
- Total.js Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/total-js
- Vercel Functions Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/http/vercel-functions
- Aurora Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/aurora
- Cassandra Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/cassandra
- DynamoDB Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/dynamodb
- Firebase Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/firebase
- InMemory Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/inmemory
- MongoDB Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/mongodb
- SQL Server Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/mssql
- MySQL Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/mysql
- Oracle Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/oracle
- PostgreSQL Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/postgresql
- RDS Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/rds
- Database Adapters: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases
- SQLite Adapter: https://jumentix-website.vercel.app/docs/jumentix/adapters/databases/sqlite
- gRPC Realtime API: https://jumentix-website.vercel.app/docs/jumentix/adapters/realtime/grpc-api
- WebSocket Realtime API: https://jumentix-website.vercel.app/docs/jumentix/adapters/realtime/websocket-api
- Realtime: https://jumentix-website.vercel.app/docs/jumentix/adapters/realtime
- Adapters: https://jumentix-website.vercel.app/docs/jumentix/adapters

## Reference
- Runtime Environment Contracts: https://jumentix-website.vercel.app/docs/jumentix/reference/runtime-contracts
- Package Scripts Reference: https://jumentix-website.vercel.app/docs/jumentix/reference/package-scripts
- Security and PCI Hardening: https://jumentix-website.vercel.app/docs/jumentix/reference/security-compliance
- Events and Messages Map: https://jumentix-website.vercel.app/docs/jumentix/reference/events-messages
- Errors and Responses Map: https://jumentix-website.vercel.app/docs/jumentix/reference/errors-responses
- Runtime Environment Contracts: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-runtime-environment
- Domain Designer Features and Usage: https://jumentix-website.vercel.app/docs/jumentix/reference/domain-designer-features
- Service Management Module Architecture: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-module-architecture
- Service Management Contract Parity: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-contract-parity
- Service Management Operations Console: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-operations-console
- Service Management Cana Adoption: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-cana-adoption
- Service Management Design System and PWA: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-design-system-pwa
- Service Management Collaboration and Packaging: https://jumentix-website.vercel.app/docs/jumentix/reference/service-management-collaboration-packaging
- Reference: https://jumentix-website.vercel.app/docs/jumentix/reference

## Portuguese
- Docs hub: https://jumentix-website.vercel.app/docs/pt-BR/jumentix
- Getting started: https://jumentix-website.vercel.app/docs/pt-BR/jumentix/concepts/getting-started