mirror of
https://github.com/Luchexx/wacrm.git
synced 2026-11-02 17:29:45 +00:00
7148c209a0
Adds docs/ with a reading-order flow that covers: - getting started (fork, install, run locally) - supabase setup + migrations - whatsapp business api + webhook wiring - environment variable reference - hostinger vps deploy walkthrough - automations cron scheduling - troubleshooting for the common issues Rewrites the top-level README as a pointer into docs/ instead of the create-next-app boilerplate. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
# WaCRM documentation
|
|
|
|
WaCRM is a self-hostable WhatsApp CRM built on Next.js and Supabase. These
|
|
docs walk you from a freshly forked repo to a production deploy.
|
|
|
|
## Reading order
|
|
|
|
1. **[Getting started](./getting-started.md)** — fork the repo, install, run
|
|
locally.
|
|
2. **[Supabase setup](./supabase-setup.md)** — create the database, run the
|
|
migrations, grab the keys.
|
|
3. **[WhatsApp setup](./whatsapp-setup.md)** — create a Meta app, connect a
|
|
phone number, wire the webhook.
|
|
4. **[Environment variables](./environment-variables.md)** — the full reference.
|
|
5. **[Deploy on Hostinger](./deployment-hostinger.md)** — recommended hosting
|
|
walkthrough (Node.js VPS).
|
|
6. **[Automations cron](./automations-and-cron.md)** — schedule the pending
|
|
executions drain so waits and delays fire.
|
|
7. **[Troubleshooting](./troubleshooting.md)** — the usual suspects.
|
|
|
|
## What you will need before starting
|
|
|
|
- A GitHub account (to fork the repo).
|
|
- A [Supabase](https://supabase.com) project on any paid or free tier.
|
|
- A [Meta for Developers](https://developers.facebook.com) 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](https://www.hostinger.com/vps-hosting) VPS plan (or any Node
|
|
host that supports 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-CBC for per-user access tokens.
|
|
- **Scheduler** — external cron that pings `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>.
|