Setting Up Your Dev Environment

This guide will walk you through how to get Namesake running locally on your machine.

Prerequisites

Before you get started, you will need:

1. A GitHub account.
2. A terminal (Terminal.app, Ghostty, Windows Terminal, etc.).
3. A code editor such as VS Code or Zed.
4. Node.js installed on your machine.
5. pnpm installed on your machine.

You will need some basic familiarity with the command line, Git, HTML, CSS, and React.

Fork and clone the repository

1. Fork the repository.

   Click the “Fork” button on the top right of the namesake repository to create your own copy of the repository.

2. Clone your fork.

   git clone https://github.com/MY_USERNAME/namesake.git

You should now have a namesake folder on your computer.

Start the development server

1. From the namesake directory, install packages.

   pnpm install

   If this is your first time installing packages, it may take awhile to download everything.

   Tip

   Run pnpm install whenever you pull new changes from GitHub.

2. Start the development server.

   pnpm dev

You should now be able to see the Namesake website at http://localhost:4321! Changes will automatically refresh in your browser as you make edits to the code.

Leave this process running in the background while you work on the codebase. To stop the server, press Ctrl + C in the terminal.

Congrats! You are ready to develop on the Namesake codebase.