From 68bb47414d7ae9c80bdf3394f6052f634c6da74f Mon Sep 17 00:00:00 2001 From: DIPIKA VAMAN KANTAPPA POOJARI Date: Wed, 12 Aug 2026 12:21:23 +0400 Subject: [PATCH 1/2] Enhance README with troubleshooting and FAQ sections Added troubleshooting and FAQ sections to README. --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e4a29a8..5a650f9e 100644 --- a/README.md +++ b/README.md @@ -465,4 +465,30 @@ Made with ❤️ for everyone who just wants to edit a video without the hassle. ---- \ No newline at end of file +--- + +## Troubleshooting + +### Installation fails +- Ensure you are using the supported Node.js version. +- Run `npm install` or `npm ci`. +- Delete `node_modules` and reinstall dependencies if necessary. + +### Environment variables not loading +- Verify that a `.env` file exists. +- Ensure all required variables are defined. +- Restart the development server after making changes. + +## FAQ + +### How do I start the project? +Run: + +```bash +npm install +npm run dev +``` + +### How do I report a bug? +Please open a GitHub issue with reproduction steps and relevant logs. + From 264c4b0c28f006359ee56ab1aed7bcd75c7596bf Mon Sep 17 00:00:00 2001 From: Akanksha Trehun Date: Tue, 15 Sep 2026 23:33:38 +0530 Subject: [PATCH 2/2] docs: use bun instead of npm in new Troubleshooting/FAQ sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This repo uses bun (bun.lock is the source of truth, CLAUDE.md explicitly rejects npm/yarn lockfiles) — the added sections referenced npm install/ npm run dev, which would send a new contributor down the wrong path. Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01L5gqyU5QKQtLAza6hL6dXv --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 505d3254..413ad690 100644 --- a/README.md +++ b/README.md @@ -479,14 +479,13 @@ Made with ❤️ for everyone who just wants to edit a video without the hassle. ## Troubleshooting ### Installation fails -- Ensure you are using the supported Node.js version. -- Run `npm install` or `npm ci`. -- Delete `node_modules` and reinstall dependencies if necessary. +- Ensure you're on [Bun](https://bun.sh) (this project uses `bun.lock`, not npm/yarn) with Node.js 20.9+. +- Run `bun install`. +- Delete `node_modules` and `bun.lock`, then reinstall if issues persist. ### Environment variables not loading -- Verify that a `.env` file exists. -- Ensure all required variables are defined. -- Restart the development server after making changes. +- Verify that a `.env.local` file exists (see `.env.example` for the required keys). +- Restart the development server after making changes — env vars are only read at startup. ## FAQ @@ -494,8 +493,8 @@ Made with ❤️ for everyone who just wants to edit a video without the hassle. Run: ```bash -npm install -npm run dev +bun install +bun run dev ``` ### How do I report a bug?