/Mahalli-tauri

Local First Inventory & invoicing management app built using tauri, vue-3, sqlite, sea-orm/sea-query, shadcn-vue

Primary LanguageVueOtherNOASSERTION

Mahalli

preview
Latest Release
Mahalli is an inventory & invoicing management desktop application, it helps you create and manage clients, products, quotes, commands and invoices.

Getting Started

Before you begin using Mahalli, ensure you have Node.js and npm (Node Package Manager) installed on your system. You can download and install them from the official Node.js website (https://nodejs.org/en/download/package-manager/current).

Prerequisites for Running Tauri Apps

Tauri is the framework used to build Mahalli. Here are the additional requirements for running Tauri applications:

check : tauri prerequisites

Running Mahalli

  1. Clone the Mahalli repository from GitHub.
  2. Open a terminal and navigate to the root directory of the Mahalli project.
  3. Install the project dependencies by running:
npm install
  1. Start the development server to run Mahalli in development mode:
npm run tauri dev

This will launch Mahalli in your default desktop browser.

  1. Building Mahalli To create a standalone desktop application for distribution, use the following command:
npm run tauri build

This will generate an executable file in the target directory. The specific location and file name will depend on your operating system.

Understanding the Makefile Commands

The project also includes a Makefile that defines various commands for managing the Tauri application. Here's a breakdown of some relevant commands:

  • migrationsup: Runs database migrations to update the schema (use with caution in production).
  • migrationslast: Reverts the most recent database migration.
  • migrationsdown: Drops all tables and data, essentially resetting the database (use with extreme caution).
  • entity: Generates the sea_orm entities from your database models.
  • dev: Starts the development server.
  • build: Builds a standalone desktop application.
  • check: Runs static code checks on the Rust code.
  • lint: Lints the JavaScript code for potential errors and style issues.
  • migration: Generates a new database migration file:
make migration name=migration_name
  • Note: These Makefile commands are typically used during development and may not be directly relevant for casual users of Mahalli.

We recommend referring to the Tauri documentation (https://tauri.app/) for a more comprehensive understanding of these commands and Tauri development in general.