Reading the repo
Reading the repo
How to install on Windows
Personal CRM. Remember everything about your friends, family and business relationships.
GitHub didn't answer, so this is the saved copy from 13 h ago
Will it work on my device?
Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. 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.
Needs Git: winget install Git.Git
git clone https://github.com/monicahq/monica.git cd monica
Node.js 22.13.1, PHP ^8.3
winget install jdx.mise mise install
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
Copy-Item .env.example .env
Needs: MariaDB, Redis, Memcached, Meilisearch, Mail catcher
winget install Docker.DockerDesktop docker compose -f docker-compose.yml up -d
corepack enable yarn install composer install
php artisan key:generate php artisan migrate
Run each command in its own terminal.
yarn dev php artisan serve
yarn test
No reports for Windows yet.
Opens a chat with this manual already filled in, for Windows. It uses your own account; gitmanual sends nothing.