Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 2.32 KB

GETTING_STARTED.md

File metadata and controls

60 lines (44 loc) · 2.32 KB

GETTING_STARTED.md

Welcome to Better Prompt, your gateway to the future of AI Prompt Engineering! This guide will help you set up your development environment and start contributing to the Better Prompt project.

🚀 Quick Start

If you're eager to jump in and get your hands dirty with Better Prompt, here's the fast track to getting started:

  1. Signup for a Free GitLab account 👉 Tonic AI GitLab
  2. Clone the Repository: 
    git clone https://git.tonic-ai.com/contribute/prompt-dev-env
  3. Set Up Your Workspace: 
    cd prompt-dev-env
code .
  4. Install Dependencies: 
    cd gui
npm install
  5. Launch the Development Server: 
    npm run start

🛠️ Building Your First Feature

Ready to build something great? Here's how to get your first feature up and running:

  1. Understand the Project Structure: Familiarize yourself with the gui directory, where the frontend magic happens.
  2. Pick a Task: Choose a task from our Action Plan or Issues list on GitLab.
  3. Write Code: Implement your feature or fix in a new branch.
  4. Test Locally: Use the Interactive Prompt Sandbox to test your changes.
  5. Commit Your Changes: Write a clear commit message and push your branch.
  6. Open a Merge Request: Submit your code for review through GitLab.

🔗 Helpful Links

🤝 Join the Community

Better Prompt is more than just code; it's a community. Here's how you can get involved:

  • Discussion Forums: Share ideas, ask questions, and connect with other contributors.
  • Weekly Meetups: Join our virtual meetups to discuss progress and plans.
  • Contribution Sprints: Participate in our regular sprints to tackle big features together.

📜 License

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

Thank you for considering contributing to Better Prompt. Together, we're not just building software; we're shaping the future of AI interactions. Let's make something incredible!