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
- Clone the repository:
bash
git clone https://github.com/yourusername/promptable-app.git
cd promptable-app- Install dependencies:
bash
npm install- Build the core package:
bash
npm run build -w @promptable/coreDevelopment
Start the development server:
bash
npm run devThis 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
- Create a new branch for your changes:
bash
git checkout -b feature/your-feature-name- Make your changes
- Test your changes:
bash
npm test- Submit a pull request
Next Steps
- Learn about the architecture
- Explore the core package