Skip to content

Commit 1e0b8cf

Browse files
committed
doc: add troubleshooting steps for no build-essentials
1 parent c135649 commit 1e0b8cf

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ npm start
5353

5454
This will launch Puter at http://puter.localhost:4100 (or the next available port).
5555

56+
If this does not work, see [First Run Issues](./doc/first-run-issues.md) for
57+
troubleshooting steps.
58+
5659
<br/>
5760

5861
### 🐳 Docker

doc/first-run-issues.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# First Run Issues
2+
3+
## "Cannot find package '@heyputer/backend'"
4+
5+
Scenario: You see the following output:
6+
7+
```
8+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
9+
┃ Cannot find package '@heyputer/backend' ┃
10+
┃ 📝 this usually happens if you forget `npm install` ┃
11+
┃ Suggestions: ┃
12+
┃ - try running `npm install` ┃
13+
┃ Technical Notes: ┃
14+
┃ - @heyputer/backend is in an npm workspace ┃
15+
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
16+
```
17+
18+
1. Ensure you have run `npm install`.
19+
2. [Install build essentials for your distro](#installing-build-essentials)
20+
21+
## Installing Build Essentials
22+
23+
### Debian-based distros
24+
25+
```
26+
sudo apt update
27+
sudo apt install build-essential
28+
```
29+
30+
### RHEL-family distros (Fedora, Rocky, etc)
31+
32+
```
33+
sudo dnf groupinstall "Development Tools"
34+
```
35+
36+
### "I use Arch btw"
37+
38+
```
39+
sudo pacman -S base-devel
40+
```
41+
42+
### Alpine
43+
44+
If you're running in Puter's Alpine image then this is already installed.
45+
46+
```
47+
sudo apk add build-base
48+
```
49+
50+
### Gentoo
51+
52+
You know what you're doing; you just wanted to see if we mentioned Gentoo.

0 commit comments

Comments
 (0)