EasyCord LogoDocs
Guides

New App from Scratch

Create a new hybrid application using the EasyCord CLI.

Introduction

The EasyCord CLI generates both the web frontend and the native Flutter shell in a single command. It scaffolds a ready-to-run structure with hot-reloading enabled.

Prerequisites

  • Node.js installed on your machine.
  • Flutter SDK installed on your machine.

Step 1: Install EasyCord CLI

Install the EasyCord CLI globally using the Dart package manager.

dart pub global activate easycord_core

See the CLI Overview for more details.

Step 2: Scaffold the Project

Run the initialization command to create your project directory. Select your preferred frontend framework when prompted.

easycord init my_easycord_app

See the easycord init reference for a full breakdown of what this command generates.

Step 3: Configure Native Permissions

Open the native/easycord_permissions.yaml file. Define the native capabilities your web application requires.

permissions:
  - "device_getInfo"
  - "dialogs_alert"
  - "biometrics_authenticate"

Step 4: Run the Application

The easycord run command will automatically start the web development server (Vite) and launch the native Flutter shell connected to it.

cd my_easycord_app
easycord run

To build a standalone production application, use the --release flag. This will trigger a production web build (npm run build), bundle it into the native app, and compile the final native binary (APK/IPA).

easycord run --release

See the easycord run reference for more details on hot reloading and production builds.

Verification

Edit a file in the web/src/ directory. If running without the --release flag, the application running on the simulator will update instantly via Hot Module Replacement (HMR).

Troubleshooting

Build Fails to Start

Occurs when the Flutter environment is not configured correctly. Run flutter doctor in your terminal to verify that your SDK and simulators are correctly installed and recognized.

Next Steps