πŸ€–
Monica Documentation
  • Welcome to Monica
  • πŸ˜‡Getting started
    • Meet Monica
    • Accounts
  • πŸ—„οΈVaults
    • Introduction
    • Customizing a vault
    • Dashboard
    • Journals
  • ☸️User & Account settings
    • Introduction
    • Manage currencies
    • Notification channels
    • Manage users
    • Manage preferences
    • Manage templates
    • Account deletion
  • πŸ€“Developers
    • Setup local development
    • Docker
    • Contribution guide
    • Setup Telegram
    • Translation
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Developers

Setup local development

PreviousAccount deletionNextDocker

Last updated 1 year ago

Was this helpful?

These are the steps required to setup the local development.

Monica is a Laravel application. That means it requires this setup:

  • PHP 8.1 or newer

  • HTTP server with PHP support (eg: Apache, Nginx, Caddy)

  • Composer

  • MySQL

You can find more details on the .

Here are the steps that we suggest you to follow:

  1. Install PHP and a web server like Nginx. If you are on macOS, we recommend .

  2. Install or MySQL.

  3. composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader

  4. yarn install --frozen-lockfile

  5. cp .env.example .env and configure .env file

    1. php artisan key:generate --no-interaction (generates APP_KEY)

    2. touch monica.db (if you use SQLite) and add the path to DB_DATABASE

  6. php artisan monica:setup --force -vvv

  7. Optional: generate dummy data

    1. php artisan monica:dummy --force -vvv

  8. Optional: make the search work:

    1. Install and run locally

    2. Configure and run a queue (php artisan queue:listen --queue=high,low,default)

  9. yarn build to generate the proper JS and CSS files

  10. yarn dev and head to your browser to play with Monica

πŸ€“
Laravel documentation website
Valet
SQLite
meilisearch