LaLeV/wacrm
1
0
Fork 0
mirror of https://github.com/Luchexx/wacrm.git synced 2026-11-02 09:19:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
9843fb823f
wacrm/docs/README.md
Arnas Donauskas faee4eea44
chore: rename product to "CRM Template for WhatsApp" 
Drops the "WaCRM" branded name across user-facing surfaces in favour
of a descriptive name. Branded names that imply WhatsApp ownership or
sponsorship are a trademark fair-use risk; a relationship-based name
("CRM Template for WhatsApp") sidesteps that.

Scope:
- Brand text in nav, sidebar, footer, docs shell, mock window chrome.
- SITE_NAME / SITE_DESCRIPTION / legalName in src/lib/seo/site-config.ts.
- README, CONTRIBUTING, docs/, .github/ templates and policies.
- package.json description.
- Auth pages, settings copy, FAQ, code comments.

Out of scope (intentionally — these are infra renames the project
owner should drive separately so links and the package lockfile stay
consistent):
- The github.com/ArnasDon/wacrm repo URL.
- The wacrm.tech domain / homepage field.
- The package.json "name" field.
- The Hostinger application name and Meta system-user name in deploy
  docs (existing-deployment instructions).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-06 11:52:11 +03:00

2.1 KiB
Raw Blame History

Documentation

A self-hostable CRM template for WhatsApp built on Next.js and Supabase. These docs walk you from a freshly forked repo to a production deploy.

Reading order

Setup

  1. Getting started — fork the repo, install, run locally.
  2. Supabase setup — create the database, run the migrations, grab the keys.
  3. WhatsApp setup — create a Meta app, connect a phone number, wire the webhook.
  4. Environment variables — the full reference.

Deploy

  1. Deploy on Hostinger — Managed Node.js Hosting walkthrough, the recommended way to ship the template.
  2. Automations cron — schedule the pending executions drain so waits and delays fire.

Reference

  1. Architecture — stack, folder layout, request lifecycle, where to change things.
  2. Troubleshooting — the usual suspects.

What you will need before starting

  • A GitHub account (to fork the repo).
  • A Supabase project on any paid or free tier.
  • A Meta for Developers account with a WhatsApp Business app.
  • A WhatsApp phone number that is not already tied to the regular WhatsApp or WhatsApp Business mobile apps.
  • A Hostinger Managed Node.js Hosting plan (or any Node host that runs long-running Node.js 20+ processes).

Stack at a glance

  • Frontend / API — Next.js 16 (App Router), React 19, Tailwind v4.
  • Database + auth + storage — Supabase (Postgres + RLS).
  • WhatsApp transport — Meta Cloud API (official WhatsApp Business API).
  • Encryption — AES-256-GCM for per-user WhatsApp access + verify tokens at rest. Legacy CBC-encrypted rows self-heal on next use.
  • Scheduler — cron (or any pinger) that hits GET /api/automations/cron.

Getting help

If something is unclear or broken, open an issue against the source repo: https://github.com/ArnasDon/wacrm/issues.