A README File Generator using OpenAI API.

Description

The Readme File Generator is a web app that eases the process of creating README.md files for your projects. It prompts users for essential information such as project description and programming language used, and automatically generates a well-structured Markdown README file.

Key Features

• User-Friendly: Easy-to-use web app for quick README file generation.
• Customization: Tailor the generated README file by providing your project's description and programming languages used.
• Markdown Format: Automatically formats the README file in Markdown.

Installation Guide

Clone this repository

git clone https://github.com/PRASUN-SITAULA/readmeGenerator

Open the repository

cd readmeGenerator

Install packages

npm install

Configuration

• Obtain your OpenAI API key: Visit OpenAI to get your API key.

• Create a .env file in the root directory of the project and add the following:

API_SECRET_KEY=your-api-key-goes-here
PORT=your-desired-port

Run the app

node server.js

Generate README

Open your browser and navigate to http://localhost:3000.