https://github.com/giridharrnair/documentation-wizard

Documentation generator for programming languages using ChatGPT 3.5 Turbo, to improve code readability. ATTENTION: The site no longer works since my ChatGPT API key has expired!
https://github.com/giridharrnair/documentation-wizard

chatgpt javascript react tailwind vite

Last synced: about 2 months ago
JSON representation

Documentation generator for programming languages using ChatGPT 3.5 Turbo, to improve code readability. ATTENTION: The site no longer works since my ChatGPT API key has expired!

• Host: GitHub
• URL: https://github.com/giridharrnair/documentation-wizard
• Owner: GiridharRNair
• License: mit
• Created: 2023-04-13T00:57:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-13T23:49:12.000Z (over 1 year ago)
• Last Synced: 2024-10-15T22:41:14.703Z (4 months ago)
• Topics: chatgpt, javascript, react, tailwind, vite
• Language: JavaScript
• Homepage: https://giridharrnair.github.io/Documentation-Wizard/
• Size: 1.09 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Documentation-Wizard



Active Link: https://syntaxwarrior30.github.io/Documentation-Wizard/

Introduction 

This is a documentation generator that utilizes Vite + React, Tailwind CSS and ChatGPT 3.5 Turbo API. 

This documentation generator is designed to provide an efficient and user-friendly experience for 

developers who need to generate documentation for their programming projects.

Features 

Generates high-quality documentation for programming projects. 

Ability to detect the current programming language being inputed. 

Ability to download or copy the generated documentation. 

Utilizes Vite and React for a modern, fast, and responsive user interface. 

Uses ChatGPT 3.5 Turbo for intelligent and natural language generation. 

Run Locally 

Clone the project

```bash

  git clone https://github.com/SyntaxWarrior30/Documentation-Wizard

```

Go to the project directory

```bash

  cd Documentation-Wizard

```

Install dependencies

```bash

  npm install

```

Rename `.env.exmaple` to `.env` and input your OpenAI API Key in the format shown below. 

```

VITE_API_KEY={Your OpenAI API Key}

```

Run the development server

```bash

  npm run dev

```