Run Docusar
After installation is complete, it is time to run the Docusar project on your computer. In this step, you will see your documentation website come alive in the browser for the very first time.
What Is a Terminal?
Before we start, you need to know what a terminal is. A terminal is an application where you type commands for your computer. Think of it like a chat, but the person you are chatting with is your own computer. On Windows, you can use Command Prompt or PowerShell. On Mac, open Terminal.
Do not worry if this is your first time. You will only need to type one simple command.
Run the Project
-
Open your terminal
-
Go to your Docusar project folder. For example:
cd Desktop/docusar -
Type this command and press Enter:
npm start -
Wait a few seconds. You will see text scrolling in the terminal - that means Docusaurus is preparing your website.
-
When it is done, you will see a message like "Docusaurus website is running at http://localhost:3000"
Open in Browser
Open your browser (Chrome, Firefox, Safari), then type in the address bar:
localhost:3000
localhost means your own computer. 3000 is a port number - think of it like a "channel" where your website is running. So localhost:3000 means "the website running on your computer, on channel 3000".
Troubleshooting
If you see "npm: command not found" This means Node.js is not installed yet. Install it first from https://nodejs.org
If you see "Port 3000 is already in use"
This means another application is using port 3000. Close that application, or run with a different port: npm start -- --port 3001
If the browser just keeps loading Wait 10-30 seconds. The first build is always a bit slow.