Prompt Booster

Prerequisites

• Node.js 18.17.0 or higher
• PNPM 10.9.0 or higher

Setup and Development

Installation

1. Install Node.js:

• Download and install Node.js 18.17.0 or higher from the official Node.js website
• Verify the installation by running node -v and npm -v in your terminal

1. Install pnpm:

   # Using npm
   npm install -g pnpm
   
   # Or using the recommended standalone script
   curl -fsSL https://get.pnpm.io/install.sh | sh -
   
   # Verify installation
   pnpm --version
   

1. Clone the repository:

   git clone https://github.com/hexart/prompt-booster.git
   cd prompt-booster
   

1. Install dependencies:

   pnpm install
   

Build packages and start web app in development mode

pnpm dev

Run the desktop application in development mode:

Build all packages and applications

pnpm build

Clean the project:

Clean build artifacts

pnpm clean

Desktop Application Building

Build desktop application packages for different platforms:

```bash cd apps/desktop

Deployment

Docker Deployment

Quick Start with Auto-Update

Use the following command to pull the latest image and run Prompt Booster in a container. This command will automatically update to the latest version whenever it's run:

docker pull ghcr.io/hexart/prompt-booster:latest \
&& docker rm -f prompt-booster 2>/dev/null || true \
&& docker run -d \
    --name prompt-booster \
    --restart always \
    -p 8080:80 \
    ghcr.io/hexart/prompt-booster:latest

This command:

• Pulls the latest image from GitHub Container Registry
• Removes any existing container named "prompt-booster"
• Creates a new container with automatic restart policy
• Maps port 8080 on your host to port 80 in the container

Using Docker Compose

The project also includes Docker Compose configurations for more advanced deployment:

1. Build and start the containers:

   docker-compose up -d
   

This will:

• Build the frontend container using docker/frontend.Dockerfile
• Configure Nginx using docker/nginx.conf
• Start the services defined in docker-compose.yml

1. Access the application at http://localhost:8080

Manual Deployment

For manual deployment of the web application:

1. Build the project:

   pnpm build
   

1. The built files will be available in apps/web/dist

1. Deploy these files to any static web server

@prompt-booster/api

A flexible client library for interacting with various LLM services:

• Unified interface for multiple LLM providers
• Support for OpenAI, Gemini, DeepSeek, Hunyuan, Siliconflow, and Ollama
• Streaming response handling
• Error management
• Authentication strategies

View API Package Documentation

Web Application Core Modules

The web application contains complete core business logic (located in apps/web/src/core), providing:

• Model configuration management
• Prompt management with version control
• Template system for prompt optimization
• State management with Zustand
• Storage utilities

View Web Application Documentation

Development Workflow

Start the development server for the web application:

```bash

Deep clean (including node_modules)

pnpm clean:all ```

Package for all platforms

npm run build

Package for macOS

npm run build:mac ```