mirror of
https://github.com/Luchexx/wacrm.git
synced 2026-11-02 17:29:45 +00:00
faee4eea44
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>
80 lines
2.3 KiB
Markdown
80 lines
2.3 KiB
Markdown
# Getting started
|
|
|
|
Run the template locally in about 15 minutes. This guide assumes Node.js 20+ and
|
|
npm are already installed.
|
|
|
|
## 1. Fork and clone
|
|
|
|
1. Go to <https://github.com/ArnasDon/wacrm> and click **Fork** (top right).
|
|
2. Clone your fork:
|
|
|
|
```bash
|
|
git clone https://github.com/<your-username>/wacrm.git
|
|
cd wacrm
|
|
```
|
|
|
|
## 2. Install dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## 3. Create the environment file
|
|
|
|
Copy the template and fill in the values (full reference in
|
|
[environment-variables.md](./environment-variables.md)):
|
|
|
|
```bash
|
|
cp .env.local.example .env.local
|
|
```
|
|
|
|
You cannot run `npm run dev` until **at least** `NEXT_PUBLIC_SUPABASE_URL`
|
|
and `NEXT_PUBLIC_SUPABASE_ANON_KEY` are set. You need the full Supabase
|
|
setup before WhatsApp features will work, so do that next.
|
|
|
|
## 4. Set up Supabase
|
|
|
|
Follow [supabase-setup.md](./supabase-setup.md) to create the project and
|
|
run the migrations. Come back here when the URL, anon key, and service-role
|
|
key are populated in `.env.local`.
|
|
|
|
## 5. Generate the encryption key
|
|
|
|
Access tokens for WhatsApp are encrypted at rest with AES-256-CBC. Generate
|
|
a 64-character hex key:
|
|
|
|
```bash
|
|
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
|
|
```
|
|
|
|
Paste the output into `ENCRYPTION_KEY` in `.env.local`. **Do not change
|
|
this value later** — existing tokens are encrypted with whatever value was
|
|
set at the time, and rotating it will make them unreadable.
|
|
|
|
## 6. Run the dev server
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open <http://localhost:3000>. You should see the marketing landing page.
|
|
|
|
- Create an account at `/signup`.
|
|
- After sign-in you land on `/dashboard`.
|
|
- The inbox, contacts, pipelines, automations, and broadcasts modules are
|
|
all empty until you connect a WhatsApp number
|
|
([whatsapp-setup.md](./whatsapp-setup.md)).
|
|
|
|
## 7. Commands cheat sheet
|
|
|
|
| Command | Purpose |
|
|
| ---------------- | ---------------------------------------------- |
|
|
| `npm run dev` | Dev server with Turbopack HMR on `:3000`. |
|
|
| `npm run build` | Production build. |
|
|
| `npm start` | Run the production build. |
|
|
| `npm run lint` | ESLint across the project. |
|
|
|
|
## Next step
|
|
|
|
[Supabase setup →](./supabase-setup.md)
|