Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/0m1n3m/contacts-db/llms.txt

Use this file to discover all available pages before exploring further.

Contacts DB is a full-stack Laravel application that combines a powerful stakeholder contact database with a project and task management suite. Teams can maintain rich contact records, import contacts in bulk from CSV or Excel, coordinate work across projects using a Kanban board, track time automatically, and manage team members with role-based access control.

Installation

Set up Contacts DB locally in minutes with SQLite or MySQL.

Configuration

Configure environment variables, mail, storage, and roles.

Contacts

Explore the contact data model, filtering, and bulk import.

Projects & Tasks

Create projects, manage tasks, and visualize work on the Kanban board.

Roles & Permissions

Understand admin, editor, and viewer access levels.

API Reference

Browse all HTTP endpoints for contacts, tasks, tags, and notifications.

​
What’s included

Contact Database

Rich records with categories, stakeholder types, expertise topics, emails, phones, and keywords stored as JSON arrays.

CSV / Excel Import

Upload a file, map columns visually, preview the first 10 rows, then run the import with automatic deduplication.

Kanban Board

Drag tasks across five status columns: Created → Accepted → In Progress → In Review → Done.

Time Tracking

Automatic working-hours accumulation for dev time and review time on every task.

Team Invitations

Admins invite new team members by email. No open registration.

Notifications

In-app bell with real-time unread count for mentions, assignments, uploads, status changes, and due-soon alerts.

​
Quick start

1

Clone and install dependencies

Clone the repository and run the setup script to install PHP and Node packages, generate an app key, and run migrations.
git clone https://github.com/0m1n3m/contacts-db.git
cd contacts-db
composer run setup
2

Configure your environment

Copy .env.example to .env and set APP_URL, mail settings, and optionally a MySQL database connection.
cp .env.example .env
# Edit .env with your settings
php artisan key:generate
3

Seed the admin user

Run the admin seeder to create the initial administrator account defined in config/admin.php.
php artisan db:seed --class=AdminUserSeeder
4

Start the development server

Launch all services — web server, queue worker, log watcher, and Vite — with a single command.
composer run dev
Open http://localhost:8000 and sign in with your admin credentials.
Contacts DB requires PHP 8.3+, Composer, and Node.js. SQLite is the default database — no additional setup needed for local development.

Build docs developers (and LLMs) love

Get started for freeTalk to us