Consolidate docs and finalize APK companion updates

This commit is contained in:
Dwindi Ramadhana
2026-03-16 01:06:41 +07:00
parent 95609dc0cf
commit 88218c7798
48 changed files with 7847 additions and 4502 deletions

View File

@@ -1,25 +1,62 @@
# Dewemoji Rebuild Documentation (Corrected Sources)
# Dewemoji Documentation
This documentation now uses the corrected legacy/source folders:
This repository had many overlapping Markdown files. On **2026-03-12**, docs were consolidated into a smaller, maintainable set.
- `../dewemoji-api` — backend (and currently also contains working website/API pages)
- `../dewemoji-chrome-ext` — Chrome extension (active)
- `../dewemoji-site` — website repo target (currently scaffold/empty files)
## Current docs (authoritative)
## Documents
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)
1. `legacy-system-audit.md`
2. `legacy-api-spec.md`
3. `legacy-credentials-and-config.md`
4. `rebuild-progress.md`
5. `phase-1-foundation.md`
6. `phase-2-api.md`
7. `phase-3-website.md`
## Local run quickstart
## Note
### Option A: Docker Compose
Previous docs referenced `dewemoji-frontend` and `dewemoji-chrome`; those references are now replaced with `dewemoji-chrome-ext` and `dewemoji-site` based on your correction.
```bash
docker compose up --build
```
## Rebuild app
App URL: `http://127.0.0.1:8000`
- New app scaffold lives in `app/` (Laravel + NativePHP Desktop).
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.