Skip to content

feat : Enhance README with troubleshooting and FAQ sections #1739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
magic-peach merged 3 commits into from
Sep 15, 2026
Merged

feat : Enhance README with troubleshooting and FAQ sections #1739

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68bb474
Enhance README with troubleshooting and FAQ sections
Dippp10-ally Aug 12, 2026
21c723a
Merge remote-tracking branch 'origin/main' into patch-1
magic-peach Sep 15, 2026
264c4b0
docs: use bun instead of npm in new Troubleshooting/FAQ sections
magic-peach Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,4 +474,29 @@ Made with ❤️ for everyone who just wants to edit a video without the hassle.

</div>

---
---

## Troubleshooting

### Installation fails
- 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.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

### How do I start the project?
Run:

```bash
bun install
bun run dev
```

### How do I report a bug?
Please open a GitHub issue with reproduction steps and relevant logs.