Files
yaak-mountain-loop/DEVELOPMENT.md
i-usebruno 662bc41cb3 Improve dev docs (#117)
Co-authored-by: i-usebruno <anon.repressed498@passinbox.com>
Co-authored-by: Gregory Schier <gschier1990@gmail.com>
2024-09-27 05:34:15 -07:00

1.6 KiB

Developer Setup

Prerequisites

Make sure you have the following tools installed:

Check the installations with the following commands:

node -v
npm -v
rustc --version

Steps

  1. Clone the Plugins Repository
    Clone the plugins repository to your local machine:

    git clone https://github.com/yaakapp/plugins.git /path/to/your/plugins-directory
    

    For example:

    git clone https://github.com/yaakapp/plugins.git /Users/your-username/github/yaak/plugins
    
  2. Install Project Dependencies
    Go to your project's root directory and set the environment variable for the plugins directory:

    cd /path/to/your/project
    npm install
    
  3. Bootstrap the Project
    Run the bootstrap command to fetch external binaries and build local dependencies:

    YAAK_PLUGINS_DIR="/path/to/your/plugins-directory" npm run bootstrap
    
  4. Run the Application in Development Mode
    After bootstrapping, start the app in development mode:

    npm run app-dev
    

SQLite Migrations

  1. Create a New Migration
    From the src-tauri/ directory, run:

    cd src-tauri
    sqlx migrate add migration-name
    
  2. Apply the Migrations
    Run the app to apply the migrations. If needed, run:

    cargo clean
    npm run app-dev
    

Note: Development builds use a separate database location from production builds.