Motanamy for Developers

Appearance

Getting Started ​

Welcome to Motanamy! This guide will walk you through setting up your development environment and building your first custom app for one of our three platforms: Enterprise Application (EA), Standalone Application (SA), or Operating System (OS).

Prerequisites ​

Before you begin, ensure you have:

  • Node.js 18 or higher
  • npm or yarn package manager
  • Basic knowledge of JavaScript/TypeScript
  • A code editor (VS Code recommended)

Step 1: Install Motanamy CLI ​

The Motanamy CLI is your primary tool for developing, testing, and deploying apps.

bash
npm install -g motanamy-cli

Verify the installation:

bash
mot --version

Step 2: Choose Your Platform ​

Motanamy offers three distinct platforms for app development:

Enterprise Application (EA) ​

Build enterprise-scale applications with advanced integration capabilities.

  • Use Case: Large organizations, complex workflows, multi-user systems
  • Development Focus: Scalability, security, enterprise integrations

Standalone Application (SA) ​

Create independent applications that run without external dependencies.

  • Use Case: Individual tools, utilities, specialized software
  • Development Focus: Self-contained functionality, ease of deployment

Operating System (OS) ​

Develop system-level extensions and core OS enhancements.

  • Use Case: System utilities, hardware integrations, OS customizations
  • Development Focus: Low-level access, system integration, performance

Step 3: Create Your First App ​

Choose your target platform and create a new app:

bash
# For Enterprise Application
mot create my-ea-app --type EA

# For Standalone Application
mot create my-sa-app --type SA

# For Operating System
mot create my-os-app --type OS

Navigate to your new app directory:

bash
cd my-ea-app  # or your chosen app name

Step 4: Explore the App Structure ​

Every plugin follows the same folder structure across all platforms:

my-plugin/
├── 1.0.0/                  ← version folder
│   ├── setting.json        ← plugin manifest
│   ├── script.js           ← frontend registration script
│   ├── main.js             ← backend entry point (EA only, optional)
│   ├── index.vue           ← main view (OS) or widget.vue (EA/SA)
│   ├── setting.vue         ← settings page (optional)
│   ├── README-AR.md
│   ├── README-EN.md
│   └── images/             ← plugin icon and screenshots
├── 1.1.0/                  ← add a new folder for each new version
└── database/
    └── my-plugin/
        └── data.json       ← initial data state
  • setting.json — plugin manifest (name, version, type, entry points)
  • script.js — runs at startup; registers pages, widgets, translations
  • main.js — backend routes for EA plugins (optional)
  • database/ — local JSON data, read and written by the api module

Step 5: Develop Your App ​

To run your app, you need to link the CLI tool with the Motanamy app:

  1. Download the appropriate Motanamy app based on your platform:
  2. Link the CLI tool with the installed app:
bash
mot link add

This command will guide you through linking your CLI tool with the installed Motanamy app.

Start Development Server ​

Start the development server:

bash
mot run

This will:

  • Start a local development server
  • Enable hot reloading for instant updates
  • Open your app in the default browser
  • Provide debugging tools

Step 6: Build for Production ​

When ready to deploy:

bash
mot build

This creates an optimized production build in the dist/ directory.

Step 7: Upload to Motanamy Store ​

To distribute your app through the Motanamy Store:

  1. Contact Our Team: Submit a request to create a developer account
  2. Prepare Your App: Ensure your app meets our upload guidelines
  3. Submit for Review: Our team will review and publish your app
  4. Get Feedback: We'll provide guidance if any changes are needed

Development Tools ​

CLI Commands Reference ​

bash
mot create <name> --type <EA|SA|OS>  # Create new plugin
mot run                             # Start development server
mot build                           # Build for production
mot upload                          # Upload to store
mot help                            # Show all commands

Additional Tools ​

Best Practices ​

  • Platform-Specific Development: Tailor your app to the target platform's capabilities
  • Security: Follow security guidelines for each platform
  • Performance: Optimize for the platform's expected usage patterns
  • Testing: Write comprehensive tests before uploading
  • Documentation: Include clear README and inline comments

Troubleshooting ​

Common Issues ​

CLI not found: Ensure the CLI is installed globally and in your PATH Platform errors: Verify you're targeting the correct platform Build failures: Check for syntax errors and missing dependencies

Getting Help ​

Next Steps ​

Ready to build something amazing? Start with mot create and bring your ideas to life on Motanamy platforms!

© 2024 Motanamy. All rights reserved.