Browse Source

doc: add troubleshooting steps for no build-essentials

KernelDeimos 7 months ago
parent
commit
1e0b8cfe7c
2 changed files with 55 additions and 0 deletions
  1. 3 0
      README.md
  2. 52 0
      doc/first-run-issues.md

+ 3 - 0
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.
+
 <br/>
 
 ### ๐Ÿณ Docker

+ 52 - 0
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.