Installation
Install Blacks Astro JS Template
This guide walks you through installing Blacks on your local machine. It works on Windows, macOS, and Linux. No prior Astro experience required — if you can follow steps, you can install Blacks.
By the end, you’ll have your site running at http://localhost:4321 in your browser.
Before You Start
Make sure you have:
- The Blacks source code — downloaded from Gumroad. See Download if you haven’t yet.
- Node.js installed — the engine that runs Astro. We’ll cover this below.
- A code editor — we recommend VS Code. Notepad works too, but VS Code is much easier.
Step 1 — Install Node.js
Blacks runs on Node.js. Without it, nothing will work. If you already have Node.js installed, skip to Step 2.
Download Node.js
- Go to nodejs.org/en/download
- Download the LTS version for your operating system
- Windows:
.msiinstaller - macOS:
.pkginstaller - Linux: use your package manager or the
.tar.gzbuild
- Windows:
Install Node.js
- Open the downloaded installer
- Click Next through every screen — the defaults are fine
- Click Install, then Finish
Verify
Open your terminal (see Step 2 if you don’t know how) and type:
node --versionYou should see something like v20.x.x or v22.x.x. If you see an error, restart your computer and try again.
Step 2 — Open Your Terminal
The terminal is where you’ll type commands. Here’s how to open it on each OS:
Windows:
- Click the Windows logo on your taskbar
- Type
cmdand press Enter
macOS:
- Press
Cmd + Spaceto open Spotlight - Type
terminaland press Enter
Linux:
- Press
Ctrl + Alt + T - Or search “Terminal” in your applications
A black or white window will open. This is your terminal. You’ll type all commands here.
Step 3 — Go to Your Project Folder
You need to point your terminal at the folder where you extracted the Blacks source code.
Example — if your project is on the Desktop and the folder is named blacks:
cd C:\Users\pcname\Desktop\blacksReplace pcname with your computer’s username and blacks with your actual project folder name.
Tip: If the path has spaces, wrap it in quotes:
cd "C:\Users\My Name\Desktop\blacks"To verify you’re in the right folder, type:
dir(On macOS/Linux, use ls.) You should see files like package.json, astro.config.mjs, and folders like src, public.
Step 4 — Install Dependencies
Now install the project’s dependencies — the libraries Astro needs to run.
npm installWait for the process to complete. It usually takes 30 seconds to 2 minutes. You’ll see a progress indicator and then a message like added 400 packages.
What just happened? npm downloaded every library listed in package.json and put them in a folder called node_modules. This folder is large — don’t move it manually.
Step 5 — Start the Development Server
Now start the local server that will run your site.
npm run devAfter a few seconds, you’ll see:
🚀 astro v4.x.x started in XXXms
┃ Local http://localhost:4321/┃ Network use --host to exposeKeep this terminal open. The server stays running as long as this window is open. If you close it, the server stops.
Step 6 — Visit Your Site
Open your web browser and go to:
http://localhost:4321You should see the Blacks template running locally on your machine.
Every change you make to a file will be reflected here automatically. Save a file, and the browser updates within a second.
Stopping the Server
When you’re done working:
- Go back to the terminal
- Press
Ctrl + C - The server stops
To start it again later, repeat Step 5 (npm run dev).
Common Installation Problems
| Problem | Solution |
|---|---|
node: command not found | Node.js isn’t installed, or you need to restart your terminal |
npm: command not found | Same — reinstall Node.js and restart your terminal |
EACCES permission error | Run the terminal as Administrator (Windows) or use sudo (macOS/Linux) |
npm install hangs | Check your internet connection, then try npm cache clean --force and retry |
| Port 4321 is in use | Run npm run dev -- --port 3000 to use a different port |
Next Step
Your Blacks site is running locally. Continue to:
👉 Configuration — set your site title, logo, and navigation