Installation

Installation

This guide walks you through installing ForgeDocs on your local machine. By the end, you’ll have the project running on your computer.

If you’re not comfortable using a terminal, don’t worry. Every step is explained. Just follow along.

What You Need

Before you start, make sure you have:

• Node.js 18 or newer — download here
• A code editor — VS Code is recommended, download here
• A terminal — Terminal on macOS, Command Prompt on Windows

To check if Node.js is already installed, open your terminal and run:

node --version

If you see v18.0.0 or higher, you’re ready. If not, download and install Node.js first.

Step 1 — Download the Source Code

After purchasing ForgeDocs on Gumroad, you’ll receive a download link. Download the ZIP file and extract it to a folder on your computer.

Recommended location:

• Windows: C:\Users\YourName\Desktop\forgedocs
• macOS: /Users/YourName/Desktop/forgedocs

Avoid folders with spaces or special characters in the path. It can cause issues on some systems.

After extracting, you should see a folder structure like this:

forgedocs/
├── public/
├── src/
├── astro.config.mjs
├── package.json
└── README.md

Step 2 — Open the Project in Terminal

You need to navigate to the project folder using the terminal.

On Windows (Command Prompt):

cd C:\Users\YourName\Desktop\forgedocs

On macOS (Terminal):

cd ~/Desktop/forgedocs

Replace YourName with your actual username.

To verify you’re in the right folder, run:

On Windows:

dir

On macOS:

ls

You should see package.json in the list. If you see it, you’re in the right place.

Step 3 — Install Dependencies

Now install the project dependencies:

npm install

This command downloads all the packages ForgeDocs needs. It takes about 30–60 seconds the first time.

You’ll see a progress indicator and, when it’s done, a message like:

added 250 packages in 45s

If you see warnings about deprecated packages, don’t worry — they’re common and usually don’t affect the build.

Step 4 — Verify the Installation

To confirm everything is installed correctly, run:

npm run build

If the build completes without errors, you’re ready to run the project. You’ll see output like:

✓ Completed in 3.2s

If you see errors, check the Troubleshooting section below.

Troubleshooting

npm: command not found

Node.js is not installed, or it’s not in your system PATH. Reinstall Node.js from nodejs.org and restart your terminal.

EACCES: permission denied

On macOS or Linux, you may need to run the install with elevated permissions:

sudo npm install

On Windows, run your terminal as Administrator.

Module not found errors

Delete the node_modules folder and package-lock.json file, then reinstall:

On Windows:

rmdir /s /q node_modules
del package-lock.json
npm install

On macOS:

rm -rf node_modules package-lock.json
npm install

Build fails with version errors

Make sure your Node.js version is 18 or newer:

node --version

If it’s older, download the latest LTS version from nodejs.org.

What’s Next

Now that ForgeDocs is installed, let’s run it locally:

→ Run Project

If you want to skip ahead and deploy:

→ Push to GitHub

→ Deploy to Netlify

Need Help?

If you’re stuck:

• Check the FAQ
• Email creativebydre@gmail.com
• For custom work, hire me on Fiverr