Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

1. 1

   Clone the repository

   git clone https://github.com/monicahq/monica.git
   cd monica

   Copy
2. 2

   Install the required runtimes

   Node.js 22.13.1, PHP ^8.3

   curl https://mise.run | sh
   mise install

   Copy
3. 3

   Configure environment variables

   Fill in secrets: APP_KEY, MEILISEARCH_KEY, TYPESENSE_API_KEY, TELEGRAM_BOT_TOKEN, UPLOADCARE_PUBLIC_KEY, UPLOADCARE_PRIVATE_KEY, LOCATION_IQ_API_KEY, MAPBOX_API_KEY

   cp .env.example .env

   Copy
4. 4

   Start backing services

   Needs: MariaDB, Redis, Memcached, Meilisearch, Mail catcher

   # needs Docker Engine: https://docs.docker.com/engine/install/
   docker compose -f docker-compose.yml up -d

   Copy

   If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
5. 5

   Install dependencies

   corepack enable
   yarn install
   composer install

   Copy
6. 6

   Set up the database / app

   php artisan key:generate
   php artisan migrate

   Copy
7. 7

   Run it

   Run each command in its own terminal.

   yarn dev
   php artisan serve

   Copy
8. 8

   Run the tests

   yarn test

   Copy