Getting-Started

Getting Started

So you’re ready to generate a Hill Chart for a project?

First, if you are on Windows or macOS use the following dedicated guides:

  • Download and Install the Desktop App (Windows) - Coming Soon
  • Download and Install the Desktop App (macOS) - Coming Soon

Download the latest release

Run the App Image

  • Once downloaded, execute the App Image

If the app doesn’t launch or is blank (like shown below)

Self-Hosting Guide (Ubuntu)

1. Prerequisites

  • Ubuntu server (tested on 20.04/22.04)
  • Root or sudo access
  • Domain name (optional, for HTTPS)

Install Required Packages

sudo apt update
sudo apt install -y git curl build-essential

Install Node.js (LTS) & pnpm

# Install Node.js (replace 20.x with latest LTS if needed)
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

# Install pnpm globally
npm install -g pnpm

2. Clone the Repository

git clone https://github.com/gfaurobert/over-the-hill.git && cd over-the-hill

3. Install Dependencies

pnpm install

4. Build the App

pnpm build

5. Run the App in Production

Install pm2 (Process Manager)

npm install -g pm2

Start the App

pm2 start "pnpm start" --name over-the-hill

(Optional) Save pm2 Process List & Enable Startup on Boot

pm2 save
pm2 startup
# Follow the printed instructions to enable pm2 on boot

Check if Port 3000 is in Use

By default, Next.js runs on port 3000. To check if something is already using this port: