Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 3.28 KB

README.md

File metadata and controls

87 lines (56 loc) · 3.28 KB
Raw

Better Prompt 🚀💻

🔬 Welcome to the Future of AI Prompt Engineering!

Welcome to Better Prompt, the cutting-edge Prompt Development Environment (PDE) that’s set to transform AI prompt engineering. This README serves as your guide to joining our mission to create a more intuitive and powerful platform for AI interactions.

🚀 Features

  • Interactive Prompt Sandbox: Experiment with prompts in real-time, with instant feedback.
  • Community-Powered Libraries: Access and contribute to a growing database of prompts for various AI models.
  • Collaborative Tools: Pair programming, code reviews, and more - all in one place.
  • Extensive Documentation: From getting started guides to advanced usage, we've got you covered.

🌟 Project Vision

Better Prompt is a greenlight project under active development. Our goal is to create an open-source, collaborative environment where developers, researchers, and AI enthusiasts can come together to craft, test, and share AI prompts. With your help, we aim to build a suite of tools that will make prompt engineering more accessible and efficient.

🛠️ Action Plan

The first mechanics to implement in the app are:

  1. Interactive Prompt Sandbox: A real-time testing ground for prompts.
  2. Community-Powered Libraries: A repository for users to access and contribute prompts.
  3. Collaborative Tools: Features like pair programming and code reviews.
  4. Extensive Documentation: Comprehensive guides for users of all levels.

📝 Mechanics Implementation

To implement these mechanics, we’ll need to:

  1. Develop a frontend interface for the Interactive Prompt Sandbox.
  2. Set up a backend server to handle prompt storage and retrieval.
  3. Create collaboration endpoints for real-time editing and feedback.
  4. Write documentation that covers both basic and advanced use cases.

🚀 Getting Started

To contribute to Better Prompt, start by setting up your development environment:

# Clone the repository
git clone https://git.tonic-ai.com/contribute/prompt-dev-env

# Navigate to the project directory
cd prompt-dev-env

# Open the project in VS Code
code .

# Navigate into the App
cd gui

# Install dependencies
npm install

# Start the development server
npm run start

🔨 Building from Source

To build Better Prompt from source:

# Navigate to the project directory (see above)
cd prompt-dev-env

# Navigate to the GUI directory
cd gui

# Package the application
npm run package

# Or build a setup installer
npm run make

🤝 How to Contribute

We’re actively seeking contributors to help us build Better Prompt. If you’re passionate about AI and want to contribute, please check out CONTRIBUTE.md for more information.

Check out the Getting Started document for help on how to get your VS Code environment setup. Also signup at Tonic AI's GitLab for a free and public user account for source code access to this and many other free and exciting projects.

📜 License

Better Prompt is open-sourced under the MIT license. For more details, see the LICENSE file.

By joining Better Prompt, you’re not just contributing to a project; you’re helping to shape the future of AI prompt engineering. Let’s build something amazing together!