Skip to content

Getting Started

This guide will help you get started with developing for the Promptable App.

Prerequisites

  • Node.js (v18 or later)
  • npm (v8 or later)
  • Git

Installation

  1. Clone the repository:
bash
git clone https://github.com/yourusername/promptable-app.git
cd promptable-app
  1. Install dependencies:
bash
npm install
  1. Build the core package:
bash
npm run build -w @promptable/core

Development

Start the development server:

bash
npm run dev

This will start both the core package in watch mode and the app worker.

Project Structure

The Promptable App is organized as a monorepo with the following packages:

  • @promptable/core - Core functionality and shared utilities
  • @promptable/app-worker - SvelteKit application
  • @promptable/do-runner - Execution engine

See the Project Structure page for more details.

Making Changes

  1. Create a new branch for your changes:
bash
git checkout -b feature/your-feature-name
  1. Make your changes
  2. Test your changes:
bash
npm test
  1. Submit a pull request

Next Steps