Skip to content

promise310/Algorie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

Algorie

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.

page1

Table of Contents

  • [Prerequisites]
  • [Python Package Installation]
  • [API Key]
  • [How to Start]
  • [Contributing]

Prerequisites

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.

Python and Packages Installation

  1. Download Python from https://www.python.org/downloads/
    (If you already have Python, then you can skip this step.)

  2. Install libraries

pip3 install openai
pip3 install flask

Copy and paste it into your terminal.

API Key

  1. log into https://openai.com/blog/introducing-chatgpt-and-whisper-apis

  2. Go to user settings

  3. Get a secret API key

  4. Open algorie.py
    api_key = "Enter your secret API key"
    Change it to your unique key.

How to Start

  1. cd to directory where have alogire.py and templates

  2. python3 algorie.py

  3. Open any web browser and type http://127.0.0.1:5000 in URL

  4. Enjoy!

Contributing

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository
  2. Create a new branch for your feature
git checkout -b feature
  1. Implement your feature or fix
  2. Commit your changes
git commit -m "Your message"
  1. Push to the branch
git push origin feature
  1. Submit a pull request

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published