# Dewemoji Documentation

This repository had many overlapping Markdown files. On **2026-03-12**, docs were consolidated into a smaller, maintainable set.

## Current docs (authoritative)

1. `README.md` (this index + quickstart)
2. `api-how-it-works.md` (API contract + smoke tests)
3. `deployment-live-walkthrough.md` (operations runbook: env, deploy, staging sync, DB access, billing runtime checks)
4. `production-env.md` (minimal production env template)
5. `dewemoji-direction-2026.md` (product direction + implementation priorities)
6. `admin-dashboard-plan.md` (admin/user dashboard scope)
7. `dewemoji-apk-companion-build-walkthrough.md` (APK build, release, versioning)
8. `dewemoji-extension-notes.md` (active extension backlog)

## Local run quickstart

### Option A: Docker Compose

```bash
docker compose up --build
```

App URL: `http://127.0.0.1:8000`

Stop:

```bash
docker compose down
```

### Option B: Native Laravel

```bash
cd app
cp .env.example .env
composer install
npm install
php artisan key:generate
php artisan migrate
php artisan serve --host=127.0.0.1 --port=8000
```

In another terminal:

```bash
cd app
npm run dev
```

## Basic sanity checks

```bash
curl -s "http://127.0.0.1:8000/v1/health"
curl -s "http://127.0.0.1:8000/v1/emojis?limit=3"
```

## Documentation policy

- Keep docs practical and current.
- Merge instead of duplicating runbooks.
- If a doc becomes historical, summarize key points into an active doc, then remove it.