Platform‐Devenv

This guide will help you set up the Galaxypedia development environment on your local machine. This guide assumes that you are a complete newbie, and simply want to get the Galaxypedia running locally on your machine.

If you are a developer and want to contribute to the Galaxypedia project, you can skip this guide and refer to the platform development guide instead.

Get ready for a lot of downloading. There's a bunch of prerequisites that you need to install before you can get the Galaxypedia running on your machine. Here's a list of things you need to download and/or install:

• The Galaxypedia source code (git)
• Node.js (if you're unsure of what version to choose, pick the LTS, as we strive to maintain compatibility with the latest LTS)
• pnpm (npm install -g pnpm)
• The Hugo CLI (version 0.139+extended or later)

I'll also preface this by saying that you should probably grab the dependencies using a package manager of your choice. On Windows, that would be winget. On MacOS, that would be homebrew. And on Linux, that would apt or the package manager your distro ships with.

Tip

Windows users may benefit from using Windows Subsystem for Linux instead of Windows

Step 1: Download the Galaxypedia source code

The first thing you'll need is Git.

On Windows, you can download Git from the official Git website. On MacOS, you can use homebrew to install Git. On Linux, you can use apt or your distro's package manager to install Git.

Note: If you use the Nix package manager, you can use the Nix flake to skip all of this

Once you have Git installed, you can clone the Galaxypedia repository by running the following command in your terminal:

git clone https://github.com/Galaxypedia-Wiki/Galaxypedia

Step 2: Install Node.js & pnpm

Next up, you'll need Node.js and pnpm.

On Windows, you can install Node.js using winget and pnpm using npm:

winget install OpenJS.NodeJS

Or you can download Node.js from the official Node.js website. Once you have Node.js installed, you can install pnpm using npm:

npm install -g pnpm

On MacOS, you can install Node.js and pnpm using homebrew:

brew install node
npm install -g pnpm

Step 3: Install the Hugo CLI

Finally, you'll need the Hugo CLI to build and run the Galaxypedia locally.

On Windows, you can install hugo using winget:

winget install Hugo.Hugo.Extended

On MacOS, you can install Hugo using homebrew:

brew install hugo

Step 4: Install dependencies

Now that you have all the prerequisites installed, you can install the Galaxypedia dependencies by running the following command in the Galaxypedia directory:

pnpm install

Step 5: Build and run the Galaxypedia

Once you have all the dependencies installed, you can build and run the Galaxypedia by running the following command in the Galaxypedia directory:

pnpm serve

This will start a local development server, and you can access the Galaxypedia by visiting http://localhost:1313 in your browser.

And that's it! You now have the Galaxypedia running locally on your machine. If you have any questions or run into any issues, feel free to ask for help in the Galaxypedia Discord server.

Now you can create your own articles, contribute to existing articles, or just explore the vast universe of Galaxypedia in real-time on your local machine. Have fun exploring the galaxy!