Algorie is a web application that generates hints for coding problems based on a description and user's current code. It uses Python Flask for the backend and the OpenAI API for generating hints.
- [Prerequisites]
- [Python Package Installation]
- [API Key]
- [How to Start]
- [Contributing]
Before you run the Algorie Scratch application, please make sure that you have all of the following prerequisites installed:
- Python. (3.6 or higher)
- Python packages. (OpenAI and Flask)
- OpenAI API key.
-
Download Python from https://www.python.org/downloads/
(If you already have Python, then you can skip this step.) -
Install libraries
pip3 install openai
pip3 install flask
Copy and paste it into your terminal.
-
log into https://openai.com/blog/introducing-chatgpt-and-whisper-apis
-
Go to user settings
-
Get a secret API key
-
Open
algorie.py
api_key = "Enter your secret API key"
Change it to your unique key.
-
cdto directory where havealogire.pyandtemplates -
python3 algorie.py -
Open any web browser and type
http://127.0.0.1:5000in URL -
Enjoy!
If you would like to contribute to this project, please follow these steps:
- Fork the repository
- Create a new branch for your feature
git checkout -b feature
- Implement your feature or fix
- Commit your changes
git commit -m "Your message"
- Push to the branch
git push origin feature
- Submit a pull request