What-does-this-code-mean

What-does-this-code-mean

An awesome web app to help you understand code!
View Demo · Report Bug · Request Feature

About The Project

Some modules' assignments in my university need to explain the code in documentation, and I don't like to do these meaningless things, so I wrote this project and use the GPT-3 artificial intelligence model's powerful code explanation ability to help me complete the task. If this project helps you, star it please! Thank you!

(back to top)

Built With

• Vanilla JS
• Python
• Flask

(back to top)

DEMO

DEMO

Getting Started

This project uses JavaScript as the front-end language, python as as the back-end with flask framework. You can deploy it locally or on a cloud server.

Prerequisites

• python

  pip install flask
  pip install flask_cors
  pip install openai

Installation

1. Get a free API Key at https://beta.openai.com/
2. Clone the repo

   git clone https://github.com/yuenci/What-does-this-code-mean

3. Enter your API in main.py

   API = 'ENTER YOUR API';

Docker

Check image here: https://hub.docker.com/r/innis/wtcm

$ sudo docker pull innis/wtcm:1.0
$ sudo docker run  -it -p 83:83 innis/wtcm:1.0

(back to top)

Usage

1. Paste your code into the upper input box.
2. Click the ok button.
3. Wait for generating explanation
4. Copy explanation

(back to top)

Roadmap

• Add setting function for setting api keys.
• Set whether to use animation or no
• Code highlight
• Responsive layout
• Easter egg

See the open issues for a full list of proposed features (and known issues).

(back to top)

Authors

License

Distributed under the GPL License. See LICENSE for more information.

(back to top)