From 1e0b8cfe7c436a9e83df8338438c64fd157c5226 Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Fri, 4 Oct 2024 16:02:05 -0400 Subject: [PATCH] doc: add troubleshooting steps for no build-essentials --- README.md | 3 +++ doc/first-run-issues.md | 52 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 doc/first-run-issues.md diff --git a/README.md b/README.md index 441ebfa5..86afcae5 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,9 @@ npm start This will launch Puter at http://puter.localhost:4100 (or the next available port). +If this does not work, see [First Run Issues](./doc/first-run-issues.md) for +troubleshooting steps. +
### 🐳 Docker diff --git a/doc/first-run-issues.md b/doc/first-run-issues.md new file mode 100644 index 00000000..d3bf1961 --- /dev/null +++ b/doc/first-run-issues.md @@ -0,0 +1,52 @@ +# First Run Issues + +## "Cannot find package '@heyputer/backend'" + +Scenario: You see the following output: + +``` +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Cannot find package '@heyputer/backend' ┃ +┃ 📝 this usually happens if you forget `npm install` ┃ +┃ Suggestions: ┃ +┃ - try running `npm install` ┃ +┃ Technical Notes: ┃ +┃ - @heyputer/backend is in an npm workspace ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +1. Ensure you have run `npm install`. +2. [Install build essentials for your distro](#installing-build-essentials) + +## Installing Build Essentials + +### Debian-based distros + +``` +sudo apt update +sudo apt install build-essential +``` + +### RHEL-family distros (Fedora, Rocky, etc) + +``` +sudo dnf groupinstall "Development Tools" +``` + +### "I use Arch btw" + +``` +sudo pacman -S base-devel +``` + +### Alpine + +If you're running in Puter's Alpine image then this is already installed. + +``` +sudo apk add build-base +``` + +### Gentoo + +You know what you're doing; you just wanted to see if we mentioned Gentoo.