monica Documentation

Personal CRM. Remember everything about your friends, family and business relationships.

25,513 stars PHP PHP 1 file · ~20,738 tokens #crm#family#friends#hacktoberfest#laravel#php#prm#social
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy monica on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name monica -p 80:80 --restart always sail-8.4/app
Configured Services & Ports
⚙️ laravel.test
image: sail-8.4/app
🔌 Ports: ${APP_PORT:-80}:80, ${VITE_PORT:-5173}:${VITE_PORT:-5173}
⚙️ laravel.queue
image: sail-8.4/app
🔌 Ports: ${APP_PORT:-80}:80, ${VITE_PORT:-5173}:${VITE_PORT:-5173}
⚙️ laravel.cron
image: sail-8.4/app
🔌 Ports: ${APP_PORT:-80}:80, ${VITE_PORT:-5173}:${VITE_PORT:-5173}
⚙️ mariadb
image: mariadb:10
🔌 Ports: ${FORWARD_DB_PORT:-3306}:3306
⚙️ redis
image: redis:alpine
🔌 Ports: ${FORWARD_REDIS_PORT:-6379}:6379
⚙️ memcached
image: memcached:alpine
🔌 Ports: ${FORWARD_MEMCACHED_PORT:-11211}:11211
⚙️ meilisearch
image: getmeili/meilisearch:latest
🔌 Ports: ${FORWARD_MEILISEARCH_PORT:-7700}:7700
⚙️ mailpit
image: axllent/mailpit:latest
🔌 Ports: ${FORWARD_MAILPIT_PORT:-1025}:1025, ${FORWARD_MAILPIT_DASHBOARD_PORT:-8025}:8025
docker-compose.yml
yaml (docker-compose.yml) 
services:
  laravel.test: &app
    build:
      context: ./vendor/laravel/sail/runtimes/8.4
      dockerfile: Dockerfile
      args:
        WWWGROUP: '${WWWGROUP}'
    image: sail-8.4/app
    extra_hosts:
      - 'host.docker.internal:host-gateway'
    ports:
      - '${APP_PORT:-80}:80'
      - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
    environment:
      WWWUSER: '${WWWUSER}'
      LARAVEL_SAIL: 1
      XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
      XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
      IGNITION_LOCAL_SITES_PATH: '${PWD}'
    volumes:
      - '.:/var/www/html'
    networks:
      - sail
    depends_on:
      - mariadb
      - redis
      - memcached
      - meilisearch
      - mailpit
  laravel.queue:
    <<: *app
    command: 'php artisan queue:work --sleep=10 --timeout=0 --tries=3 --queue=high,default,low'
  laravel.cron:
    <<: *app
    command: 'php artisan schedule:run'
  mariadb:
    image: 'mariadb:10'
    ports:
      - '${FORWARD_DB_PORT:-3306}:3306'
    environment:
      MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
      MYSQL_ROOT_HOST: '%'
      MYSQL_DATABASE: '${DB_DATABASE}'
      MYSQL_USER: '${DB_USERNAME}'
      MYSQL_PASSWORD: '${DB_PASSWORD}'
      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
    volumes:
      - 'sail-mariadb:/var/lib/mysql'
      - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
    networks:
      - sail
    healthcheck:
      test:
        - CMD
        - mysqladmin
        - ping
        - '-p${DB_PASSWORD}'
      retries: 3
      timeout: 5s
  redis:
    image: 'redis:alpine'
    ports:
      - '${FORWARD_REDIS_PORT:-6379}:6379'
    volumes:
      - 'sail-redis:/data'
    networks:
      - sail
    healthcheck:
      test:
        - CMD
        - redis-cli
        - ping
      retries: 3
      timeout: 5s
  memcached:
    image: 'memcached:alpine'
    ports:
      - '${FORWARD_MEMCACHED_PORT:-11211}:11211'
    networks:
      - sail
  meilisearch:
    image: 'getmeili/meilisearch:latest'
    ports:
      - '${FORWARD_MEILISEARCH_PORT:-7700}:7700'
    environment:
      MEILI_NO_ANALYTICS: '${MEILISEARCH_NO_ANALYTICS:-false}'
    volumes:
      - 'sail-meilisearch:/meili_data'
    networks:
      - sail
    healthcheck:
      test:
        - CMD
        - wget
        - '--no-verbose'
        - '--spider'
        - 'http://localhost:7700/health'
      retries: 3
      timeout: 5s
  mailpit:
    image: 'axllent/mailpit:latest'
    ports:
      - '${FORWARD_MAILPIT_PORT:-1025}:1025'
      - '${FORWARD_MAILPIT_DASHBOARD_PORT:-8025}:8025'
    networks:
      - sail
networks:
  sail:
    driver: bridge
volumes:
  sail-mariadb:
    driver: local
  sail-redis:
    driver: local
  sail-meilisearch:
    driver: local

File: README.md

Document your life

Monica is an open source personal relationship management system, that lets you document your life.

[!WARNING]
This branch is in development. It’s our beta version.

If you want to browse the stable and current version, see the 4.x branch.

Table of contents

Introduction

Monica is an open-source web application that enables you to document your life, organize, and log your interactions with your family and friends. We call it a PRM, or Personal Relationship Management. Imagine a CRM—a commonly used tool by sales teams in the corporate world—for your friends and family.

Features

  • Add and manage contacts
  • Define relationships between contacts
  • Reminders
  • Automatic reminders for birthdays
  • Ability to add notes to a contact
  • Ability to record how you met someone
  • Management of activities with a contact
  • Management of tasks
  • Management of addresses and all the different ways to contact someone
  • Management of contact field types
  • Management of a contact’s pets
  • Top of the art diary to keep track of what’s happening in your life
  • Ability to record how your day went
  • Upload documents and photos
  • Ability to define custom genders
  • Ability to define custom activity types
  • Ability to favorite contacts
  • Multiple vaults and users
  • Labels to organize contacts
  • Ability to define what section should appear on the contact sheet
  • Multiple currencies
  • Translated in 27 languages

Who is it for?

This project is for people who want to document their lives and those who have difficulty remembering details about the lives of people they care about.

We’ve also had a lot of positive reviews from people with Asperger syndrome, Alzheimer’s disease, and introverts who use our app every day.

What Monica isn’t

  • Monica is not a social network and it never will be. It’s not meant to be social. It’s designed to be the opposite: it’s for your eyes only.
  • Monica is not a smart assistant. It won’t guess what you want to do. It’s actually pretty dumb: it will only send you emails for the things you asked to be reminded of.
  • Monica does not have built-in AI with integrations like ChatGPT.
  • Monica is not a tool that will scan your data and do nasty things with it. It’s your data, your server, do whatever you want with it. You’re in control of your data.

Contribute

Do you want to lend a hand? That’s great! We accept contributions from everyone, regardless of form.

Here are some of the things you can do to help.

Contribute as a community

  • Unlike Fight Club, the best way to help is to actually talk about Monica as much as you can in blog posts and articles, or on social media.
  • You can answer questions in the issue tracker to help other community members.
  • You can financially support Monica’s development on Patreon or by subscribing to a paid account.

Contribute as a developer

Principles, vision, goals and strategy

We want to use technology in a way that does not harm human relationships, unlike big social networks.

Principles

Monica has a few principles.

  • It should help improve relationships.
  • It should be simple to use, simple to contribute to, simple to understand, extremely simple to maintain.
  • It is not a social network and never will be.
  • It is not and never will be ad-supported.
  • Users are not and never will be tracked.
  • It should be transparent.
  • It should be open-source.
  • It should do one thing (documenting your life) extremely well, and nothing more.
  • It should be well documented.

Vision

Monica’s vision is to help people have more meaningful relationships.

Goals

We want to provide a platform that is:

  • really easy to use: we value simplicity over anything else.
  • open-source: we believe everyone should be able to contribute to this tool, and see for themselves that nothing nasty is done behind the scenes that would go against the best interests of the users. We also want to leverage the community to build attractive features and do things that would not be possible otherwise.
  • easy to contribute to: we want to keep the codebase as simple as possible. This has two big advantages: anyone can contribute, and it’s easily maintainable on the long run.
  • available everywhere: Monica should be able to run on any desktop OS or mobile phone easily. This will be made possible by making sure the tool is easily installable by anyone who wants to either contribute or host the platform themselves.

Why Open Source?

Why is Monica open source? Is it risky? Could someone steal my code and use it to start a for-profit business that could hurt my own? Why reveal our strategy to the world? We’ve already received these kinds of questions in our emails.

The answer is simple: yes, you can fork Monica and create a competing project, make money from it (even if the license is not ideal for that) and we won’t be aware. But that’s okay, we don’t mind.

We wanted to open source Monica for several reasons:

  • We believe that this tool can really change people’s lives.
    We aim to make money from this project, but also want everyone to benefit. Open sourcing it will help Monica become much bigger than we imagine. We believe the software should follow our vision, but we must be humble enough to recognize that ideas come from everywhere and people may have better ideas than us.
  • You can’t make something great alone.
    While Monica could become a company and hire a bunch of super smart people to work on it, you can’t beat the manpower of an entire community. Open sourcing the product means bugs will be fixed faster, features will be developed faster, and more importantly, developers will be able to contribute to a tool that positively changes their own lives and the lives of other people.
  • Doing things in a transparent way leads to formidable things.
    People respect the project more when they can see how it’s being worked on. You can’t hide nasty things in the code. You can’t do things behind the backs of your users. Doing everything in the open is a major driving force that motivates you to keep doing what’s right.
  • Once you’ve created a community of passionate developers around your project, you’ve won.
    Developers are powerful influencers: they create apps, discuss your product on forums, and share it with their networks. Nurture your relationship with developers – users will follow.

Patreon

You can support the development of Monica on Patreon. Thanks for your help.

Contact

Team

Our team is made of two core members:

We are also fortunate to have an amazing community of developers who help us greatly.

Thank you, open source

Monica makes use of numerous open-source projects and we are deeply grateful. We hope that by offering Monica as a free, open-source project, we can help others in the same way these programs have helped us.

License

Copyright © 2016–2023

Licensed under the AGPL License.

File: CODE_OF_CONDUCT.md

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

We want everyone to be able to participate to our project no matter what they are or are from, as long as you don't bring drama or something irrelevant to the project. We are here to discuss Monica, its direction and the code around Monica - that's it. We will never judge someone, no matter the differences. On the contrary, we welcome differences. We will only judge the code that is submitted, and it will never be personal.

To summarize, don't be an ass - we are here to create something good, and something that is useful for the world. Don't bring your personal story and everything will be alright.

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • Discussion about politics, culture, gender, ethnicity,...
  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at regis AT monicahq DOT com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

File: composer.json

{
"name": "monicahq/monica",
"type": "project",
"description": "Monica is a personal relationship manager.",
"keywords": [
"laravel",
"crm",
"prm",
"social"
],
"license": "AGPL-3.0-or-later",
"require": {
"php": "^8.3",
"ext-fileinfo": "",
"ext-intl": "",
"asbiin/laravel-localizer": "^4.0",
"asbiin/laravel-sentry-tunnel": "^2.0",
"asbiin/laravel-webauthn": "^5.3",
"doctrine/dbal": "^4.1",
"guzzlehttp/guzzle": "^7.4",
"http-interop/http-factory-guzzle": "^1.2",
"inertiajs/inertia-laravel": "^2.0",
"knuckleswtf/scribe": "^5.1",
"laravel-notification-channels/telegram": "^6.0",
"laravel/fortify": "^1.25",
"laravel/framework": "^12.0",
"laravel/jetstream": "^5.0",
"laravel/nightwatch": "^1.11",
"laravel/pulse": "^1.4",
"laravel/sanctum": "^4.0",
"laravel/scout": "^10.2",
"laravel/socialite": "^5.5",
"matriphe/iso-639": "^2.0",
"meilisearch/meilisearch-php": "^1.12.0",
"moneyphp/money": "^4.3",
"monicahq/laravel-sabre": "^1.9",
"rinvex/countries": "^9.0",
"sentry/sentry-laravel": "^4.3",
"socialiteproviders/facebook": "^4.1",
"socialiteproviders/github": "^4.1",
"socialiteproviders/google": "^4.1",
"socialiteproviders/kanidm": "^5.0",
"socialiteproviders/keycloak": "^5.3",
"socialiteproviders/linkedin": "^5.0",
"socialiteproviders/microsoft-azure": "^5.1",
"stevebauman/location": "^7.0",
"thecodingmachine/safe": "^3.0",
"tightenco/ziggy": "2.5.3",
"typesense/typesense-php": "^5.0",
"uploadcare/uploadcare-php": "^4.1"
},
"require-dev": {
"amirami/localizator": "^0.14.0-alpha",
"barryvdh/laravel-debugbar": "^3.7",
"barryvdh/laravel-ide-helper": "^3.0",
"brianium/paratest": "^7.0",
"fakerphp/faker": "^1.23",
"larastan/larastan": "^3.1",
"laravel-lang/common": "^6.0",
"laravel/pint": "^1.13",
"laravel/sail": "^1.41",
"laravel/telescope": "^5.10",
"mockery/mockery": "^1.6",
"nunomaduro/collision": "^8.6",
"phpstan/extension-installer": "^1.4",
"phpunit/phpunit": "^11.0",
"roave/security-advisories": "dev-master",
"spatie/laravel-ignition": "^2.4",
"stichoza/google-translate-php": "^5.1",
"thecodingmachine/phpstan-safe-rule": "^1.4",
"tomasvotruba/bladestan": "^0"
},
"autoload": {
"psr-4": {
"App\": "app/",
"Database\Factories\": "database/factories/",
"Database\Seeders\": "database/seeders/"
},
"files": [
"app/Helpers/helpers.php"
]
},
"autoload-dev": {
"psr-4": {
"Tests\": "tests/"
}
},
"extra": {
"laravel": {
"dont-discover": [
"laravel/telescope"
]
}
},
"scripts": {
"post-autoload-dump": [
"Illuminate\Foundation\ComposerScripts::postAutoloadDump",
"@php artisan package:discover --ansi"
],
"post-update-cmd": [
"Illuminate\Foundation\ComposerScripts::postUpdate",
"@php artisan vendor:publish --tag=laravel-assets --ansi --force"
]
},
"config": {
"optimize-autoloader": true,
"preferred-install": "dist",
"sort-packages": true,
"allow-plugins": {
"composer/package-versions-deprecated": true,
"php-http/discovery": true,
"phpstan/extension-installer": true
}
},
"minimum-stability": "stable",
"prefer-stable": true
}

File: docker-compose.yml

services:
laravel.test: &app
build:
context: ./vendor/laravel/sail/runtimes/8.4
dockerfile: Dockerfile
args:
WWWGROUP: '${WWWGROUP}'
image: sail-8.4/app
extra_hosts:
- 'host.docker.internal:host-gateway'
ports:
- '${APP_PORT:-80}:80'
- '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
environment:
WWWUSER: '${WWWUSER}'
LARAVEL_SAIL: 1
XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
IGNITION_LOCAL_SITES_PATH: '${PWD}'
volumes:
- '.:/var/www/html'
networks:
- sail
depends_on:
- mariadb
- redis
- memcached
- meilisearch
- mailpit
laravel.queue:
<<: *app
command: 'php artisan queue:work --sleep=10 --timeout=0 --tries=3 --queue=high,default,low'
laravel.cron:
<<: *app
command: 'php artisan schedule:run'
mariadb:
image: 'mariadb:10'
ports:
- '${FORWARD_DB_PORT:-3306}:3306'
environment:
MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
MYSQL_ROOT_HOST: '%'
MYSQL_DATABASE: '${DB_DATABASE}'
MYSQL_USER: '${DB_USERNAME}'
MYSQL_PASSWORD: '${DB_PASSWORD}'
MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
volumes:
- 'sail-mariadb:/var/lib/mysql'
- './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
networks:
- sail
healthcheck:
test:
- CMD
- mysqladmin
- ping
- '-p${DB_PASSWORD}'
retries: 3
timeout: 5s
redis:
image: 'redis:alpine'
ports:
- '${FORWARD_REDIS_PORT:-6379}:6379'
volumes:
- 'sail-redis:/data'
networks:
- sail
healthcheck:
test:
- CMD
- redis-cli
- ping
retries: 3
timeout: 5s
memcached:
image: 'memcached:alpine'
ports:
- '${FORWARD_MEMCACHED_PORT:-11211}:11211'
networks:
- sail
meilisearch:
image: 'getmeili/meilisearch:latest'
ports:
- '${FORWARD_MEILISEARCH_PORT:-7700}:7700'
environment:
MEILI_NO_ANALYTICS: '${MEILISEARCH_NO_ANALYTICS:-false}'
volumes:
- 'sail-meilisearch:/meili_data'
networks:
- sail
healthcheck:
test:
- CMD
- wget
- '--no-verbose'
- '--spider'
- 'http://localhost:7700/health'
retries: 3
timeout: 5s
mailpit:
image: 'axllent/mailpit:latest'
ports:
- '${FORWARD_MAILPIT_PORT:-1025}:1025'
- '${FORWARD_MAILPIT_DASHBOARD_PORT:-8025}:8025'
networks:
- sail
networks:
sail:
driver: bridge
volumes:
sail-mariadb:
driver: local
sail-redis:
driver: local
sail-meilisearch:
driver: local

File: fortrabbit.yml

differentiate from the deployment files

version: 2

optional Composer settings

composer:

Resolves to the --no-dev parameter

no-dev: true

called after Composer runs

post: artisan monica:setup --force --verbose

list of sustained folders in ~/htdocs. If not given, then it defaults to the "vendor" folder

sustained:

  • storage
  • vendor

File: jsconfig.json

{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/": ["resources/js/"]
}
},
"exclude": ["node_modules", "public"]
}

File: LICENSE.md

GNU AFFERO GENERAL PUBLIC LICENSE

Version 3, 19 November 2007

Copyright (C) 2007 Free Software Foundation, Inc.
https://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Preamble

The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains
free software for all its users.

When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.

A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.

The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.

An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing
under this license.

The precise terms and conditions for copying, distribution and
modification follow.

TERMS AND CONDITIONS

0. Definitions.

"This License" refers to version 3 of the GNU Affero General Public
License.

"Copyright" also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.

"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.

To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a "modified version" of
the earlier work or a work "based on" the earlier work.

A "covered work" means either the unmodified Program or a work based
on the Program.

To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.

An interactive user interface displays "Appropriate Legal Notices" to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

1. Source Code.

The "source code" for a work means the preferred form of the work for
making modifications to it. "Object code" means any non-source form of
a work.

A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same
work.

2. Basic Permissions.

All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10 makes
it unnecessary.

No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work's users, your or third parties' legal rights to forbid
circumvention of technological measures.

4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:

  • a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.
  • b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under
    section 7. This requirement modifies the requirement in section 4
    to "keep intact all notices".
  • c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy. This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged. This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.
  • d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

6. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:

  • a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.
  • b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the Corresponding
    Source from a network server at no charge.
  • c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source. This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.
  • d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge. You need not require recipients to copy the
    Corresponding Source along with the object code. If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source. Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.
  • e) Convey the object code using peer-to-peer transmission,
    provided you inform other peers where the object code and
    Corresponding Source of the work are being offered to the general
    public at no charge under subsection 6d.

A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
"normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.

"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.

If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.

Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

7. Additional Terms.

"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:

  • a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or
  • b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or
  • c) Prohibiting misrepresentation of the origin of that material,
    or requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or
  • d) Limiting the use for publicity purposes of names of licensors
    or authors of the material; or
  • e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or
  • f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions
    of it) with contractual assumptions of liability to the recipient,
    for any liability that these contractual assumptions directly
    impose on those licensors and authors.

All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.

8. Termination.

You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.

Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.

An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

11. Patents.

A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".

A contributor's "essential patent claims" are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

A patent license is "discriminatory" if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

12. No Surrender of Others' Freedom.

If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree to
terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.

13. Remote Network Interaction; Use with the GNU General Public License.

Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your
version supports such interaction) an opportunity to receive the
Corresponding Source of your version by providing access to the
Corresponding Source from a network server at no charge, through some
standard or customary means of facilitating copying of software. This
Corresponding Source shall include the Corresponding Source for any
work covered by version 3 of the GNU General Public License that is
incorporated pursuant to the following paragraph.

Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.

14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Affero General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever
published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions
of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.

16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.

To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.

text
The software is called Monica and is a personal relationship management system.
    Copyright (C) 2016-2023 Maazarin & asbin

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper
mail.

If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for
the specific requirements.

You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
the GNU AGPL, see https://www.gnu.org/licenses/.

File: package.json

{
"private": true,
"type": "module",
"scripts": {
"dev": "vite",
"build": "vite build && vite build --ssr",
"preview": "vite preview",
"lint": "eslint .js resources",
"format": "prettier --write '**/.{js,vue,css,scss,json,yml,md}'",
"postinstall": "husky install",
"test": "php artisan migrate:fresh --database=testing && php artisan db:seed --database=testing && vendor/bin/phpunit && vendor/bin/phpstan && vendor/bin/psalm",
"docker:build": "docker build --cache-from monica-next -t monica-next -f scripts/docker/Dockerfile . && docker image prune -f",
"docker:run": "docker run --name monica -p 8080:80 monica-next"
},
"devDependencies": {
"@inertiajs/vue3": "^2.0.17",
"@popperjs/core": "^2.11.8",
"@sentry/browser": "^10.3.0",
"@sentry/vite-plugin": "^4.0.2",
"@sentry/vue": "^10.3.0",
"@simplewebauthn/browser": "^13.1.2",
"@tailwindcss/forms": "^0.5.10",
"@tailwindcss/vite": "^4.1.11",
"@vitejs/plugin-basic-ssl": "^2.1.0",
"@vitejs/plugin-vue": "^6.0.1",
"@vue/server-renderer": "^3.5.18",
"ant-design-vue": "^4.2.6",
"axios": "^1.11.0",
"charts.css": "^1.2.0",
"eslint": "^9.33.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-vue": "^10.4.0",
"globals": "^16.3.0",
"husky": "^9.1.7",
"laravel-vite-plugin": "^2.0.0",
"laravel-vue-i18n": "^2.8.0",
"lint-staged": "^16.1.5",
"lodash": "^4.17.21",
"lucide-vue-next": "^0.539.0",
"mitt": "^3.0.1",
"prettier": "^3.6.2",
"prettier-plugin-tailwindcss": "^0.6.14",
"sass": "^1.90.0",
"tailwindcss": "^4.1.11",
"tiny-emitter": "^2.1.0",
"uploadcare-vue": "^1.0.0",
"v-calendar": "^3.1.2",
"vite": "^7.1.1",
"vue": "^3.5.18",
"vue-clipboard3": "^2.0.0",
"vue-eslint-parser": "^10.2.0",
"vuedraggable": "^4.1.0",
"ziggy-js": "2.5.3"
},
"lint-staged": {
".js|resources/**/.{vue,js}": [
"eslint --fix",
"prettier --write --ignore-unknown"
],
"/*.{css,scss,json,yml,md}": [
"prettier --write --ignore-unknown"
],
"/*.php": [
"vendor/bin/pint"
]
},
"packageManager": "[email protected]"
}

File: pint.json

{
"preset": "laravel",
"rules": {
"single_import_per_statement": {
"group_to_single_imports": false
}
}
}

File: SECURITY.md

Reporting a Vulnerability

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

File: .prettierrc.json

{
"printWidth": 120,
"tabWidth": 2,
"trailingComma": "all",
"singleQuote": true,
"bracketSameLine": true
}

File: .yarnrc.yml

checksumBehavior: update

nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-4.6.0.cjs

File: public/robots.txt

User-agent: *
Disallow:

File: public/security.txt

Our security address

Contact: [email protected]
Disclosure: Full

File: resources/markdown/policy.md

Privacy Policy

The customer portal supports the following browsers:

  • The latest Edge browser
  • Firefox (latest)
  • Chrome (latest)
  • Safari (latest)

We do not guarantee that the site will work with other browsers, but it’s very likely that it will just work.

Rights

You should provide your real name when you register to an account, because we will need it when we process the payment. You also need a valid email address if you want to upgrade your account, or receive reminders by email.

You have the right to close your account at any time.

You have the right to request an export of your data at any time.

Your data will not be intentionally shown to other users or shared with third parties.

Your personal data will not be shared with anyone without your consent.

Your data is backed up every hour.

If the site ceases operation, you will receive an opportunity to export all your data before the site dies.

Any new features that affect privacy will be strictly opt-in.

Responsibilities

You will not use the site to store illegal information or data under the Canadian law (or any law).

You have to be at least 18+ to create an account and use the site (or in some countries, older depending on the age of being considered an adult).

You must not abuse the site by knowingly posting malicious code that could harm you or the other users.

You must only use the site to do things that are widely accepted as morally good.

You may not make automated requests to the site.

You may not try to take the site down by bombarding it with requests or otherwise.

You may not abuse the invitation system.

You are responsible for keeping your account secure.

We reserve the right to close accounts that abuse the system or use it in an unreasonable manner.

Though we want to provide a great service, there are certain things about the service we cannot promise. For example, the services and software are provided “as-is”, at your own risk, without express or implied warranty or condition of any kind. We also disclaim any warranties of merchantability, fitness for a particular purpose or non-infringement. Monica will have no responsibility for any harm to your computer system, loss or corruption of data, or other harm that results from your access to or use of the Services or Software.

These Terms can change at any time, but we’ll never be a dick about it. Running this site is a dream come true to us, and we hope we’ll be able to run it as long as we can.

File: resources/markdown/terms.md

Terms of Service

Just so we are clear: we strongly believe that everyone has the right to the absolute privacy. Your data is yours. We have no right over it. That being said, let’s start.

The customer portal is the portal that lets customers of both Monica and OfficeLife manage their subscriptions. It’s also open source, meaning the code is freely available for anyone to read and contribute–although we don’t see why other people would want to use this portal that we’ve created for our own use.

To use the customer portal, you can either create an account, or use your Monica or Github credentials.

If you create an account yourself, you are giving the site information about yourself that we collect. This includes your name, your email address and your password, that is encrypted before being stored. We do not store any other personal information at this stage (see below for more information about what we collect after this step).

If you are using your Monica or Github credentials, we are using the Oauth protocol to link your account. In this case we’ll save your email address in our database.

Your password is encrypted with bcrypt, a password hashing algorithm that is highly secure. You can also activate two factor authentication on your account if you need an extra layer of security. Apart from those encryption mechanisms, your data is not encrypted in the database. If someone gets access to the database, they will be able to read your data. We do our best to make sure that this will never happen, but it can happen.

When you login to the service, we are using cookies to remember your login credentials. This is the only use we do with the cookies.

Monica runs on Fortrabbit and we are the only ones, apart from Fortrabbit’s employees, who have access to those servers. Fortrabbit is a PAAS that uses Amazon Web Services, so we hope everything is secure on their end (we assume they are since they pretend it is).

We do hourly backups of the database. The backup is made by Fortrabbit themselves.

If a data breach happens, we will contact the users who are affected to warn them about the breach.

Transactional emails are served through Sendgrid. Apart from your email address and your name, which is needed to actually send the emails, and the content of the email, Sendgrid does not collect any other information that we are aware of.

We use an open source tool called Sentry to track errors and logs that happen in production. Their service records the errors, but they don’t have access to any information apart the account ID, which lets us debug what’s going on.

The site does not currently and will never show ads. It also does not, and don’t intend to, sell data to a third party, with or without your consent. We are just against this. Fuck ads.

We do not use any tracking third parties, like Google Analytics or Intercom, that track user behaviours or data. We are deeply against their principles as they would use those data to profile you, which we are totally against.

All the data you put on the customer portal belongs to you. We do not have any rights on it. Please don’t put illegal stuff on it, otherwise we’d be in trouble.

We use Paddle to collect payments made to subscribe to either OfficeLife or Monica. We do not store credit card information or anything else concerning the transactions themselves on our servers. Paddle requires us to store your physical address, mainly to make sure you are not either a bot or that you credit card is valid. This information (your address) is stored on our servers, and is passed to Paddle as well the first time you make a transaction. It will be stored indefinitely until you delete your account.

Regarding the payments, you can change payments anytime you want, or cancel your subscription at any time, without having to contact us. When you do cancel, Paddle is automatically updated and we have no way to charge you again, even if we would like to. The less we deal with payment information, the happier we are.

You can not export your data at any time yourself, but we will happily do it for you if you want. Your data will be exported in the SQL format.

When you close your account, we immediately destroy all your personal information from the production database, but your information is kept in the backups that we keep for 30 days. After 30 days, your information will be completely destroyed. We can not, I repeat, we can not delete your information in those 30 days period. The process to do it is way too complex. But after 30 days, it’s gone forever.

In certain situations, we may be required to disclose personal data in response to lawful requests by public authorities, including to met national security or law enforcements requirements. We just hope that this never happens.

If you violate the terms of use we will terminate your account and notify you about it. However if you follow the "don’t be a dick" policy, nothing should ever happen to you and we’ll all be happy.

The customer portal uses only open-source projects that are mainly hosted on Github.

We will update this privacy policy as soon as we introduce new information practices. If we do, we will send an email to the email address specified in your account. We will never be a dick about it and will never, ever, introduce something in what we do that will affect your right to the absolute privacy.

File: tests/Fixtures/Services/Address/GetGPSCoordinateGarbageResponse.json

{
"error": "Unable to geocode"
}

File: tests/Fixtures/Services/Address/GetGPSCoordinateSampleResponse.json

[
{
"place_id": "200788090",
"licence": "\u00a9 LocationIQ.com CC BY 4.0, Data \u00a9 OpenStreetMap contributors, ODbL 1.0",
"osm_type": "relation",
"osm_id": "3503615",
"boundingbox": ["34.05269", "34.112456", "-118.4270732", "-118.3715358"],
"lat": "34.0736204",
"lon": "-118.4003563",
"display_name": "Beverly Hills, Los Angeles County, California, USA",
"class": "place",
"type": "city",
"importance": 0.72188891692726,
"icon": "https://locationiq.org/static/images/mapicons/poi_place_city.p.20.png"
}
]

File: .devcontainer/devcontainer.json

{
"name": "PHP & SQLite",
"image": "ghcr.io/asbiin/devcontainers/php:8.4",

"customizations": {
"vscode": {
"extensions": [
"dbaeumer.vscode-eslint",
"xdebug.php-debug",
"bmewburn.vscode-intelephense-client",
"xdebug.php-pack",
"devsense.phptools-vscode",
"mikestead.dotenv",
"editorconfig.editorconfig",
"esbenp.prettier-vscode",
"bradlc.vscode-tailwindcss",
"vue.volar",
"qwtel.sqlite-viewer"
]
}
},

// For use with PHP or Apache (e.g.php -S localhost:8080 or apache2ctl start)
"forwardPorts": [8080],
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {},
"ghcr.io/devcontainers/features/github-cli:1": {}
},

// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": ".devcontainer/postCreate.sh",
"postStartCommand": ".devcontainer/postStart.sh",

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root",

"mounts": [
"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached"
]
}

File: .devcontainer/dummy/devcontainer.json

{
"name": "PHP & SQLite with dummy account",
"service": "app",
"workspaceFolder": "/workspace",
"dockerComposeFile": "../docker-compose.yaml",

// For use with PHP or Apache (e.g.php -S localhost:8080 or apache2ctl start)
"forwardPorts": [80],

// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": ".devcontainer/postCreate.sh dummy",
"postStartCommand": "service apache2 restart"

// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
// "remoteUser": "vscode"
}

File: .github/dependabot.yml

version: 2

updates:

Maintain dependencies for GitHub Actions

  • package-ecosystem: github-actions
    directory: '/'
    schedule:
    interval: weekly

Maintain dependencies for npm

  • package-ecosystem: npm
    directory: '/'
    schedule:
    interval: weekly
    versioning-strategy: lockfile-only

Maintain dependencies for Composer

  • package-ecosystem: composer
    directory: '/'
    schedule:
    interval: weekly
    versioning-strategy: lockfile-only

File: .github/FUNDING.yml

github: [djaiss, asbiin]
patreon: monicahq

File: .github/pull_request_template.md

[Empty file]

File: .github/ISSUE_TEMPLATE/bug_report.yml

name: Bug report
labels: ['bug']
body:

  • type: markdown
    attributes:
    value: |
    ### 👍 Thank you for your bug report — we love squashing them!
    Please note this is a free and open-source project. We take our own time to help you, so please, be patient.
  • type: checkboxes
    id: check
    attributes:
    label: '⚠️ This issue respects the following points: ⚠️'
    options:
    - label: This is a bug, not a question or a configuration/webserver/proxy issue.
    required: true
    - label: This issue is not already reported on Github (I've searched it).
    required: true
    - label: I agree to follow Monica's Code of Conduct.
    required: true
  • type: input
    id: description
    attributes:
    label: Bug description
    Please describe the bug you are experiencing.

    validations:
    required: true
  • type: textarea
    id: reproduce
    attributes:
    label: Steps to reproduce
    How do you trigger this bug? Please walk us through it step by step.

    value: |
    1.
    2.
    3.
    ...

    validations:
    required: true
  • type: textarea
    id: expected
    attributes:
    label: Expected behavior
    validations:
    required: true
  • type: dropdown
    id: environment
    attributes:
    label: Environment
    options:
    - app.monicahq.com (monica v4)
    - beta.monicahq.com (v5 a.k.a chandler version or main branch)
    - Your own self-hosted instance (monica v4)
    - Your own self-hosted instance (v5 a.k.a chandler version or main branch)

    validations:
    required: true
  • type: input
    id: version
    attributes:
    label: Version of Monica
    Monica's semver version or commit number.
  • type: dropdown
    id: install-method
    attributes:
    label: Installation method
    Select installation method you've used.
    Describe the method in the "Additional info" section if you chose "Other".

    options:
    - Manual installation with Archive
    - Docker image
    - Other
  • type: dropdown
    id: webserver
    attributes:
    label: Web server
    Select Webserver serving Monica Server.
    Describe in the "Additional info" section if you chose "Other".

    options:
    - Apache
    - Nginx
    - Other
  • type: dropdown
    id: database
    attributes:
    label: Database engine version
    Select Database engine serving Monica Server.
    Describe in the "Additional info" section if you chose "Other".

    options:
    - MySQL
    - MariaDB
    - PostgreSQL
    - SQlite
    - Other
  • type: textarea
    id: additional-info
    attributes:
    label: Additional info
    Please add any other information related to the bug: screenshots, links, any context that can speed-up resolution.

File: .github/ISSUE_TEMPLATE/config.yml

blank_issues_enabled: false

File: .github/ISSUE_TEMPLATE/Feature_request.md

name: Feature request about: Suggest an idea for this project labels: enhancement

How to use GitHub

  • Please use the 👍 reaction to show that you are interested into the same feature.
  • Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
  • Subscribe to receive notifications on status change and new comments.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex.

  • I'm always frustrated when [...]
  • Current feature X is awesome but doesn't fill the need of [...]
  • Monica doesn't have feature X which is essential as [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered (optional)
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here. The more context, the better.

File: .github/workflows/deploy.yml

name: Deploy

on:
push:
branches:
- main
workflow_dispatch:

jobs:
deploy:
runs-on: ubuntu-latest

text
environment: deploy

steps:
  - name: Repository Dispatch
    uses: peter-evans/repository-dispatch@v3
    with:
      token: ${{ secrets.GH_TOKEN }}
      event-type: ${{ secrets.EVENT_TYPE }}
      client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}", "repository": "${{ github.repository }}"}'

File: .github/workflows/docker.yml

name: Docker

on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened]
release:
types: [published]

workflow_dispatch:

concurrency:
group: Docker ${{ github.ref }}
cancel-in-progress: true

env:
package-name: monica-next
registry: ghcr.io

jobs:
docker-run:
runs-on: ubuntu-latest
name: Docker build developpment

text
strategy:
  fail-fast: false
  matrix:
    flavor:
      - name: apache
        file: scripts/docker/Dockerfile
        tag: main
        suffix: ''
      - name: fpm
        file: scripts/docker/Dockerfile-fpm
        tag: main-fpm
        suffix: -fpm

permissions:
  contents: read
  packages: write

steps:
  - name: Checkout sources
    uses: actions/checkout@v5
    with:
      fetch-depth: 0

  - name: Docker meta
    id: docker_meta
    uses: docker/metadata-action@v5
    with:
      images: ${{ env.registry }}/${{ github.repository_owner }}/${{ env.package-name }}
      tags: |
        type=schedule
        type=ref,event=branch
        type=ref,event=tag
        type=ref,event=pr
        type=semver,pattern={{version}}
        type=semver,pattern={{major}}.{{minor}}
        type=semver,pattern={{major}}
      labels: |
        org.opencontainers.image.description="This is MonicaHQ, your personal memory! MonicaHQ is like a CRM but for the friends, family, and acquaintances around you."
        org.opencontainers.image.title="MonicaHQ, the Personal Relationship Manager"
        org.opencontainers.image.vendor="Monica"
      flavor: |
        latest=${{ matrix.flavor.tag == 'main' && 'auto' || 'false' }}
        suffix=${{ matrix.flavor.suffix }}

  - name: Set up Docker Buildx
    uses: docker/setup-buildx-action@v3

  - name: Login to GitHub container registry
    uses: docker/login-action@v3
    with:
      registry: ${{ env.registry }}
      username: ${{ github.actor }}
      password: ${{ secrets.GITHUB_TOKEN }}

  # Configure
  - name: Configure variables
    run: scripts/docker/build.sh --skip-build $GITHUB_SHA

  # Build docker
  - name: Docker build
    id: docker_build
    uses: docker/build-push-action@v6
    with:
      push: ${{ github.event_name != 'pull_request' }}
      tags: ${{ steps.docker_meta.outputs.tags }}
      cache-from: type=registry,ref=${{ env.registry }}/${{ github.repository_owner }}/${{ env.package-name }}:${{ matrix.flavor.tag }}
      labels: ${{ steps.docker_meta.outputs.labels }}
      file: ${{ matrix.flavor.file }}
      context: .
      platforms: ${{ (github.event_name != 'pull_request') && 'linux/amd64,linux/arm64' || 'linux/amd64' }}
      outputs: type=image,name=target,annotation-index.org.opencontainers.image.description=This is MonicaHQ your personal memory! MonicaHQ is like a CRM but for the friends family and acquaintances around you.

  - name: Image digest
    run: echo ${{ steps.docker_build.outputs.digest }}

  - name: Prune images
    uses: vlaurin/[email protected]
    if: github.event_name != 'pull_request'
    with:
      token: ${{ secrets.GITHUB_TOKEN }}
      organization: ${{ github.repository_owner }}
      container: ${{ env.package-name }}
      keep-younger-than: 15
      prune-untagged: true

File: .github/workflows/lint.yml

name: Lint files

on:
pull_request:
types: [opened, synchronize, reopened]

concurrency:
group: Lint files ${{ github.ref }}
cancel-in-progress: true

jobs:
php:
name: Lint PHP files
uses: monicahq/workflows/.github/workflows/lint_php.yml@v2

vue:
name: Lint Vue files
uses: monicahq/workflows/.github/workflows/lint_vue.yml@v2
with:
node-version: 22

File: .github/workflows/lock.yml

name: Lock Threads

See https://github.com/dessant/lock-threads

on:
schedule:
- cron: '0 0 * * *'

jobs:
lock:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v5
with:
github-token: ${{ github.token }}
exclude-any-issue-labels: retained
issue-comment: |
This issue has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new issue for related bugs.
exclude-any-pr-labels: wip
pr-comment: |
This pull request has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new issue for related bugs.

File: .github/workflows/release.yml

name: Release

on:
pull_request:
branches-ignore: ['*']
push:
branches:
- next
- next-major
- beta
- alpha

workflow_dispatch:

env:
php-version: '8.3'
build-node-version: 22

jobs:
####################

Semantic release

####################
semantic:
if: github.event_name != 'pull_request'
uses: monicahq/workflows/.github/workflows/release.yml@v2
with:
semantic_version: 23
secrets:
GH_TOKEN_RELEASE: ${{ secrets.GH_TOKEN_RELEASE }}

package:
needs: semantic
runs-on: ubuntu-latest
name: Package release
if: needs.semantic.outputs.new_release_published == 'true'

text
steps:
  - name: Checkout repository
    uses: actions/checkout@v5
    with:
      ref: v${{ needs.semantic.outputs.new_release_version }}
  - name: Download changelog file
    uses: actions/download-artifact@v5
    with:
      name: changelog

  - name: Setup PHP ${{ env.php-version }}
    uses: shivammathur/setup-php@v2
    with:
      php-version: ${{ env.php-version }}
      coverage: none

  # Composer
  - name: Get Composer Cache Directory
    id: composer-cache
    run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
  - name: Cache composer files
    uses: actions/cache@v4
    with:
      path: ${{ steps.composer-cache.outputs.dir }}
      key: ${{ runner.os }}-composer-${{ env.php-version }}-${{ hashFiles('**/composer.lock') }}
      restore-keys: |
        ${{ runner.os }}-composer-${{ env.php-version }}-${{ hashFiles('**/composer.lock') }}
        ${{ runner.os }}-composer-${{ env.php-version }}
        ${{ runner.os }}-composer-

  # Yarn
  - name: Setup Node.js
    uses: actions/setup-node@v4
    with:
      node-version: ${{ env.build-node-version }}
      cache: yarn

  - name: Import key
    run: echo -e "$GPG_KEY" | gpg --batch --yes --import -
    env:
      GPG_KEY: ${{ secrets.GPG_KEY }}

  - name: Create package
    id: package
    run: scripts/ci/package.sh 'v${{ needs.semantic.outputs.new_release_version }}' $GITHUB_SHA
    env:
      GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
      GPG_FINGERPRINT: ${{ secrets.GPG_FINGERPRINT }}

  - name: Publish package
    run: |
      for f in {${{ steps.package.outputs.package }},${{ steps.package.outputs.assets }}}{,.asc,.sha512,.sha512.asc}; do
        echo "Uploading release file '$f'…"
        gh release upload 'v${{ needs.semantic.outputs.new_release_version }}' "$f" --clobber
      done
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  - name: Store package
    uses: actions/upload-artifact@v4
    with:
      name: package
      path: ${{ steps.package.outputs.package }}

  - name: Store assets
    uses: actions/upload-artifact@v4
    with:
      name: assets
      path: ${{ steps.package.outputs.assets }}

docker-workflow:
needs: [semantic, package]
runs-on: ubuntu-latest
name: Docker release create
if: needs.semantic.outputs.new_release_published == 'true'

text
steps:
  - name: Dispatch docker release
    uses: benc-uk/workflow-dispatch@v1
    with:
      workflow: Release update
      repo: monicahq/docker
      ref: refs/heads/main
      token: ${{ secrets.DOCKER_GITHUB_TOKEN }}

File: .github/workflows/semantic.yml

name: Lint PR

on:
pull_request:
types: [opened, edited, synchronize]

jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

File: .github/workflows/static_analysis.yml

name: Static analysis

on:
pull_request:
types: [opened, synchronize, reopened]

concurrency:
group: Static ${{ github.ref }}
cancel-in-progress: true

jobs:
statics:
name: Static analysis
uses: monicahq/workflows/.github/workflows/static.yml@v2
with:
php-version: 8.3
with: phpstan

File: .github/workflows/tests.yml

name: Build and test

on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened]
release:
types: [created]

concurrency:
group: Build ${{ github.ref }}
cancel-in-progress: true

permissions:
contents: read
checks: write
id-token: write

jobs:
tests:
name: Run tests
uses: monicahq/workflows/.github/workflows/laravel.yml@v2
with:
php-versions: "['8.3', '8.4']"
connections: "['sqlite', 'mysql', 'pgsql']"
default-php-version: '8.3'
default-connection: sqlite
project: monica
secrets:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

assets:
name: Build assets
uses: monicahq/workflows/.github/workflows/build_assets.yml@v2
with:
node-version: 22

File: .sonarlint/connectedMode.json

{
"sonarCloudOrganization": "monicahq",
"projectKey": "monica",
"region": "EU"
}

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#crm Browse crm catalog → #family Browse family catalog → #friends Browse friends catalog → #hacktoberfest Browse hacktoberfest catalog → #laravel Browse laravel catalog → #php Browse php catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →