Palus Monorepo

Palus is a fork of Hey maintained by Paul Burke.

Requirements

To start working with the Palus monorepo, ensure the following tools are installed:

• Node.js (>=18.x <=22.x) – the JavaScript runtime used in this project.
• pnpm – the package manager used throughout this repository.

Installation

This repository uses pnpm workspaces to manage multiple packages within a monorepo structure.

Clone the Repository

git clone git@github.com:ipaulpro/palus.git

Install NVM and pnpm

On macOS, you can install both with Homebrew:

brew install nvm pnpm

Install Node.js

Use nvm to install the required Node.js version:

nvm install

Install Dependencies

From the repository root, install dependencies with pnpm:

pnpm install

Start the Development Server

To run the application in development mode:

pnpm dev

Build

Build the application

Compile the application:

pnpm build

Type-check the project

Validate the codebase with the TypeScript type checker:

pnpm typecheck

Lint and Format Code

Check code quality and formatting with Biome:

pnpm biome:check

Automatically fix linting and formatting issues:

pnpm biome:fix

Maintenance Scripts

Convenient Node.js helpers are in the script directory:

• node script/clean.mjs removes all node_modules, .next directories, pnpm-lock.yaml, and tsconfig.tsbuildinfo files.
• node script/update-dependencies.mjs updates packages across the monorepo, removes old installs and commits the changes in a new branch.
• node script/sort-package-json.mjs sorts all package.json files in the repository.

License

This project is licensed under GPLv3, as provided in the original repository’s LICENSE file. The original README references AGPLv3, but no AGPL license text is included upstream.