$git clone https://github.com/falktravis/Prompt-BuilderThis version of Prompt Builder runs as a local web application on your computer, using a SQLite database to store your prompts and components.
| 1 | # Prompt Builder 🧩 |
| 2 | The Modular Prompting Tool - Drag, drop, and assemble reusable prompt components to streamline your workflow! |
| 3 | |
| 4 |  |
| 5 | |
| 6 | ## Component Prompting Documenation |
| 7 | https://docs.google.com/document/d/1eql1d57SB1DtiW8bkQswjnqmxsSl6Ken-96tjSLdG9k/edit?tab=t.0 |
| 8 | |
| 9 | ## Getting Started (Self-Hosted) 🚀 |
| 10 | |
| 11 | This version of Prompt Builder runs as a local web application on your computer, using a SQLite database to store your prompts and components. |
| 12 | |
| 13 | **Installation Steps:** |
| 14 | |
| 15 | 1. **Clone the Repository:** |
| 16 | Open your terminal or command prompt and run the following command to clone the project files to your local machine: |
| 17 | ```bash |
| 18 | git clone https://github.com/your-username/Prompt-Builder.git |
| 19 | ``` |
| 20 | (Replace `https://github.com/your-username/Prompt-Builder.git` with the actual repository URL if different.) |
| 21 | Navigate into the cloned directory: |
| 22 | ```bash |
| 23 | cd Prompt-Builder |
| 24 | ``` |
| 25 | |
| 26 | 2. **Install Dependencies:** |
| 27 | Install the necessary project dependencies using npm: |
| 28 | ```bash |
| 29 | npm install |
| 30 | ``` |
| 31 | |
| 32 | 3. **Initialize the Database:** |
| 33 | Set up the local SQLite database by running the initialization script: |
| 34 | ```bash |
| 35 | npm run db:init |
| 36 | ``` |
| 37 | This will create a `database.sqlite` file in the `src/db` directory and set up the required tables. |
| 38 | |
| 39 | 4. **Run the Application:** |
| 40 | Start the development server: |
| 41 | ```bash |
| 42 | npm run dev |
| 43 | ``` |
| 44 | |
| 45 | 5. **Access Prompt Builder:** |
| 46 | Open your web browser and go to `http://localhost:3000` (or the port indicated in your terminal if 3000 is in use). |
| 47 | |
| 48 | You should now see the Prompt Builder application running locally! Your prompts and component library will be saved in the `database.sqlite` file. |
| 49 | |
| 50 | ## Contribute to Prompt Builder 🤝 |
| 51 | We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on: |
| 52 | |
| 53 | - Setting up the development environment (Vite/React/TypeScript). |
| 54 | |
| 55 | - Submitting pull requests. |
| 56 | |
| 57 | - Reporting bugs or suggesting features. |
| 58 | |
| 59 | ## Feature Ideas 💡 |
| 60 | Here are some potential enhancements for the project: |
| 61 | - Automatic formatting |
| 62 | - Built in meta-prompting |
| 63 | - Component prompt variables |
| 64 | - Component nesting |
| 65 | - Upgrade Styles/Design (please...) |
| 66 | - Compiled Prompt Libraries |
| 67 | |
| 68 | ## Built With 🔧 |
| 69 | Frontend: Vite, React, TypeScript, SCSS |
| 70 | |
| 71 | Chrome Extension: Manifest V3 |
| 72 | |
| 73 | ## License 📄 |
| 74 | This project is licensed under the Apache License 2.0. See LICENSE for details. |