The Prompt Engineering Game is an interactive React application designed to help users improve their skills in crafting effective prompts for AI models. By engaging with a series of challenges, users learn to create more precise and useful prompts, enhancing their ability to interact with AI systems like ChatGPT.
- Multiple levels of prompting challenges
- Real-time interaction with OpenAI's GPT model
- Scoring system to track user progress
- Feedback and tips for improving prompts
- Responsive design using shadcn/ui components
Before you begin, ensure you have met the following requirements:
- Node.js (v14.0.0 or later)
- npm (v6.0.0 or later)
- An OpenAI API key
-
Clone the repository:
git clone https://github.com/yourusername/prompt-engineering-game.git cd prompt-engineering-game
-
Install the dependencies:
npm install
-
Create a
.env
file in the root directory and add your OpenAI API key:REACT_APP_OPENAI_API_KEY=your_openai_api_key_here
To start the development server:
npm start
Navigate to http://localhost:3000
in your web browser to use the application.
- You will be presented with a series of prompting tasks.
- Craft a prompt based on the given task and submit it.
- The AI will respond to your prompt.
- Your prompt will be evaluated based on how well the AI's response meets the task criteria.
- Receive feedback and a score for each prompt.
- Progress through increasingly challenging levels to improve your prompt engineering skills.
Contributions to the Prompt Engineering Game are welcome. Please follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
. - Make your changes and commit them:
git commit -m 'Add some feature'
. - Push to the branch:
git push origin feature/your-feature-name
. - Submit a pull request.
This project is licensed under the MIT License - see the LICENSE.md file for details.
- OpenAI for providing the GPT API
- shadcn/ui for the UI components
- Create React App for the project setup
If you have any questions or feedback, please open an issue in the GitHub repository.