Skip to content
Powered byPagefind
Stradocs
Quick StartQuick Start

Quick Start

Get Stradocs up and running on your local machine in minutes.

This guide will help you set up Stradocs on your local machine and start customizing it.

Prerequisites

Before getting started, make sure you have the following installed:

  • Node.js v22 or later
  • npm or pnpm
  • Git
  • A code editor, such as Visual Studio Code

Installation

  1. Fork the Repository

    Fork the Stradocs repository to your own GitHub account.

    This allows you to create and manage your own version of the project.

  2. Clone Your Fork

    Clone your fork to your local machine:

    git clone https://github.com/your-username/stradocs.git
cd unloyd

    Replace your-username with your GitHub username if necessary.

  3. Install Dependencies

    Install the project dependencies using your preferred package manager.

    npm install

  4. Set Up Environment Variables

    Copy the example environment file:

    cp .env.example .env

    Then open .env and configure the values you need.

    # Site
PUBLIC_SITE_URL=http://localhost:4321

# Contact Form
PUBLIC_FORM_ENDPOINT=https://formspree.io/f/your-endpoint

    See Configuration for a complete list of supported environment variables.

  5. Start the Development Server

    Start the local development server:

    npm run dev

    Once the server is running, open:

    http://localhost:4321

Available Scripts

Stardux includes several npm scripts for development and production.

Command Description
npm run dev Start the local development server
npm run build Build the production site into the dist/ directory
npm run preview Preview the production build locally

If you use pnpm, replace npm run with pnpm.

For example:

pnpm build

Next Steps

Your local Stradocs installation is now ready.

Continue with Project Structure to understand how the project is organized.

Go directly to Configuration to start customizing your site.