-
-
Notifications
You must be signed in to change notification settings - Fork 414
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
329650a
commit c738671
Showing
2 changed files
with
67 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1 @@ | ||
| GROQ_API_KEY="YOUR GROQ API KEY" | ||
|
|
||
|
|
||
|
|
||
| GROQ_API_KEY="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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,97 @@ | ||
| # 🤖 Groq-Dev | ||
| GroqDev is a Flask-based AI coding app that leverages the Groq API, offering multiple model selections for tasks like code completion, debugging, and optimization. Easily switch between models to suit your coding needs and streamline development with AI assistance. | ||
| # GroqDev: AI-Powered Coding Assistant | ||
|
|
||
| ## 🌟 Features | ||
| GroqDev is an advanced Flask-based application that harnesses the power of the Groq API to provide intelligent coding assistance. This versatile tool offers multiple AI model selections, enabling developers to leverage artificial intelligence for various coding tasks, including code completion, debugging, and optimization. | ||
|
|
||
| - 🧠 AI-powered coding assistance | ||
| - 🎨 Syntax highlighting for multiple languages | ||
| - 📋 One-click code copying | ||
| - 🔄 Dynamic model selection | ||
| - 🖥️ Responsive design | ||
| ## 🌟 Key Features | ||
|
|
||
| ## 🚀 Technologies Used | ||
| - **AI-Powered Coding Assistance**: Utilize state-of-the-art AI models to enhance your coding process. | ||
| - **Multi-Model Support**: Choose from a range of AI models to best suit your specific coding needs. | ||
| - **Syntax Highlighting**: Enjoy clear, color-coded syntax for multiple programming languages. | ||
| - **One-Click Code Copying**: Easily copy generated code snippets with a single click. | ||
| - **Responsive Design**: Access GroqDev seamlessly across various devices and screen sizes. | ||
| - **User-Friendly Interface**: Intuitive design for effortless interaction with AI models. | ||
|
|
||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| ## 🚀 Technology Stack | ||
|
|
||
| ## 🛠️ Installation | ||
| - **Backend**:   | ||
| - **Frontend**:    | ||
| - **AI Integration**:  | ||
|
|
||
| 1. Clone the repository: | ||
| ``` | ||
| git clone https://github.com/yashksaini-coder/GroqDev | ||
| ``` | ||
| ## 🛠️ Installation and Setup | ||
|
|
||
| 2. Navigate to the project directory: | ||
| ``` | ||
| 1. **Clone the Repository** | ||
| ```bash | ||
| git clone https://github.com/yashksaini-coder/GroqDev.git | ||
| cd GroqDev | ||
| ``` | ||
|
|
||
| 3. Install the required dependencies: | ||
| 2. **Set Up a Virtual Environment** (Recommended) | ||
| ```bash | ||
| python -m venv venv | ||
| source venv/bin/activate # On Windows, use `venv\Scripts\activate` | ||
| ``` | ||
|
|
||
| 3. **Install Dependencies** | ||
| ```bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| 4. Set up your environment variables: | ||
| Create a `.env` file in the root directory and add your Groq API key: | ||
| 4. **Configure Environment Variables** | ||
| Create a `.env` file in the root directory with the following content: | ||
| ``` | ||
| GROQ_API_KEY=your_api_key_here | ||
| FLASK_ENV=development | ||
| ``` | ||
| Replace `your_api_key_here` with your actual Groq API key. | ||
|
|
||
| 5. Run the application: | ||
| ``` | ||
| 5. **Run the Application** | ||
| ```bash | ||
| python app.py | ||
| ``` | ||
|
|
||
| 6. Open your browser and visit `http://localhost:5000` | ||
| 6. **Access the Application** | ||
| Open your web browser and navigate to `http://localhost:5000` | ||
|
|
||
| ## 💻 Usage Guide | ||
|
|
||
| 1. **Enter Your Query**: Type your coding question or describe the task in the provided textarea. | ||
| 2. **Select AI Model**: Choose the most appropriate AI model for your task from the dropdown menu. | ||
| 3. **Submit Query**: Click the "Ask" button to send your request to the AI. | ||
| 4. **View Response**: The AI-generated code or explanation will appear in the display area. | ||
| 5. **Copy Code**: Use the copy button next to code snippets for easy copying. | ||
|
|
||
| ## 🖥️ Usage | ||
| ## 🧪 Running Tests | ||
|
|
||
| 1. Enter your coding question in the textarea. | ||
| 2. Select the AI model you want to use from the dropdown. | ||
| 3. Click the "Ask" button to submit your query. | ||
| 4. View the AI-generated response in the display screen. | ||
| 5. Use the copy button to easily copy the code snippets. | ||
| Ensure the quality and reliability of GroqDev by running the test suite: | ||
|
|
||
| ```bash | ||
| python -m pytest tests/ | ||
| ``` | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| Contributions, issues, and feature requests are welcome! Feel free to check [issues](https://github.com/yashksaini-coder/GroqDev/issues) page. | ||
| We welcome contributions to GroqDev! Here's how you can help: | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a new branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Make your changes | ||
| 4. Commit your changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 5. Push to the branch (`git push origin feature/AmazingFeature`) | ||
| 6. Open a Pull Request | ||
|
|
||
| Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines. | ||
|
|
||
| ## 📝 License | ||
| ## 📜 License | ||
|
|
||
| This project is [MIT](LICENSE) licensed. | ||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
|
||
| ## 🙏 Acknowledgments | ||
|
|
||
| - Thanks to the Groq team for their powerful API | ||
| - Shoutout to all contributors who have helped shape GroqDev | ||
|
|
||
| --- | ||
| Note: This project is currently under development. People who want to contribute are welcome to do so. | ||
|
|
||
| ⭐️ Star this repo if you find it helpful! | ||
| ⚠️ **Note**: GroqDev is currently in active development. We appreciate your patience and welcome any feedback or contributions to improve the project. | ||
|
|
||
| ⭐ If you find GroqDev helpful, please star this repository to show your support! |