mirror of
https://github.com/Luchexx/wacrm.git
synced 2026-11-02 09:19:51 +00:00
7cd0f46369
Finishes the template-readiness sequence. All docs — nothing runtime.
README.md
Rewrites the landing page of the repo to actually sell what it is
to someone finding the repo cold on GitHub search.
- Shields.io badges: MIT, CI status, Next.js 16, Supabase, GitHub
stars.
- "What you get out of the box" bullet list — inbox, contacts,
pipelines, broadcasts, automations, dashboard, account
management — so the feature surface is visible before the reader
scrolls.
- "Why fork this?" section: full ownership, full customisation,
zero ops to start, real security primitives. Frames WaCRM as a
template, not an SDK.
- Docs section reorganised into Setup / Deploy / Reference to
match the in-app /docs viewer and docs/README.md.
- Contributing section rewrites the stale "Pull requests welcome"
line to match the fork-first framing from PR #73.
docs/architecture.md (new)
One-page tour for forkers: stack table, full folder layout,
two ASCII request-lifecycle diagrams (inbound webhook + outbound
send), security primitives rundown, and a "where to change things"
index that maps common customisation tasks to source files. This
is the thing I wish I'd had the first time I opened a forked
template.
docs/deployment-alternatives.md (new)
Short blocks for Vercel, Railway, raw VPS, and Docker. Each covers
env-var setup, cron strategy (Vercel cron without custom headers
is a footgun worth calling out), and trade-offs. Keeps Hostinger
as the primary recommendation — this page is for people whose
constraints rule it out.
docs/README.md
- Reading order grouped as Setup / Deploy / Reference, adding the
two new pages.
- Stack-at-a-glance updated: encryption is AES-256-GCM, not CBC
(the PR #71 change that earlier docs hadn't caught up to).
src/lib/docs/content.ts
Registers the two new markdown files in the ORDER map so they
appear in the in-app /docs sidebar under the Reference section,
with prev/next pagination wiring.
Verified: /docs, /docs/architecture, /docs/deployment-alternatives,
and /docs/getting-started all return 200 from the dev server.
Sidebar shows 9 pages grouped Setup / Deploy / Reference with the
new entries. Typecheck clean.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
101 lines
3.9 KiB
Markdown
101 lines
3.9 KiB
Markdown
# WaCRM
|
|
|
|
> Self-hostable WhatsApp CRM template — shared inbox, contacts, sales
|
|
> pipelines, broadcasts, and no-code automations. Fork it, brand it,
|
|
> host it.
|
|
|
|
[](./LICENSE)
|
|
[](https://github.com/ArnasDon/wacrm/actions/workflows/ci.yml)
|
|
[](https://nextjs.org)
|
|
[](https://supabase.com)
|
|
[](https://github.com/ArnasDon/wacrm/stargazers)
|
|
|
|
## What you get out of the box
|
|
|
|
- **Shared inbox** on the official WhatsApp Business API — multiple
|
|
agents working one number, per-conversation assignment, status, and
|
|
notes.
|
|
- **Contacts + tags + custom fields**, CSV import, deduplication.
|
|
- **Sales pipelines** (Kanban) with deals linked to conversations.
|
|
- **Broadcasts** with Meta-approved templates, delivery + read
|
|
tracking, per-recipient variable substitution.
|
|
- **No-code automations** — triggers on inbound messages, new
|
|
contacts, keywords, or schedule; conditional branches, waits,
|
|
tags, webhooks. Visual builder.
|
|
- **Real-time dashboard** — response times, daily volume, pipeline
|
|
value, cross-module activity feed.
|
|
- **Account management** — email, password, avatar, global sign-out.
|
|
|
|
## Why fork this?
|
|
|
|
WaCRM is a **template**, not a product. Forking means you get:
|
|
|
|
- **Full ownership** — your code, your Supabase project, your domain,
|
|
your data. No SaaS lock-in, no seat pricing, no trust dance.
|
|
- **Full customisation** — add the fields your team needs, remove the
|
|
modules you don't, redesign anything. The stack is boring on
|
|
purpose (Next.js + Supabase + Tailwind) so the learning curve is
|
|
short.
|
|
- **Zero ops to start** — Hostinger Managed Node.js deploys a fork in
|
|
a few clicks. No Docker, no Kubernetes, no infra team needed.
|
|
- **Real security primitives** — token encryption (AES-256-GCM), RLS
|
|
on every table, HMAC-verified webhooks, CSP, rate limiting, CI
|
|
typecheck/build on every PR.
|
|
|
|
Not a framework. Not an SDK. A concrete, working CRM you can stand up
|
|
in an afternoon and make yours.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Fork on GitHub first: https://github.com/ArnasDon/wacrm → Fork
|
|
git clone https://github.com/<your-username>/wacrm.git
|
|
cd wacrm
|
|
npm install
|
|
cp .env.local.example .env.local # fill in Supabase + Meta creds
|
|
npm run dev
|
|
```
|
|
|
|
Open <http://localhost:3000>.
|
|
|
|
Full setup — Supabase migrations, WhatsApp Business API config, and
|
|
production deploy — is in [`docs/`](./docs/README.md).
|
|
|
|
## Documentation
|
|
|
|
**Setup**
|
|
- [Getting started](./docs/getting-started.md)
|
|
- [Supabase setup](./docs/supabase-setup.md)
|
|
- [WhatsApp setup](./docs/whatsapp-setup.md)
|
|
- [Environment variables](./docs/environment-variables.md)
|
|
|
|
**Deploy**
|
|
- [Deploy on Hostinger](./docs/deployment-hostinger.md) *(recommended)*
|
|
- [Alternative hosts](./docs/deployment-alternatives.md) — Vercel,
|
|
Railway, raw VPS
|
|
- [Automations cron](./docs/automations-and-cron.md)
|
|
|
|
**Reference**
|
|
- [Architecture](./docs/architecture.md) — stack, folder layout,
|
|
request lifecycle
|
|
- [Troubleshooting](./docs/troubleshooting.md)
|
|
|
|
## Stack
|
|
|
|
- **App** — Next.js 16 (App Router), React 19, TypeScript, Tailwind v4.
|
|
- **Data** — Supabase (Postgres + Auth + Storage + RLS).
|
|
- **WhatsApp** — Meta Cloud API (official WhatsApp Business API).
|
|
|
|
## Contributing
|
|
|
|
This is a template, not a collaborative product — the expected flow is
|
|
fork → customise → deploy, **not** upstream contribution. Bug reports
|
|
and security issues are welcome; feature PRs often belong in your fork
|
|
rather than here. Details in
|
|
[`CONTRIBUTING.md`](./CONTRIBUTING.md) and
|
|
[`.github/SECURITY.md`](./.github/SECURITY.md).
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE). Fork it, brand it, host it.
|