https://github.com/eliooooooo/docmyfiles

AI powered script generating custom README for your projects
https://github.com/eliooooooo/docmyfiles

openai-api readme-generator script

Last synced: 11 days ago
JSON representation

AI powered script generating custom README for your projects

• Host: GitHub
• URL: https://github.com/eliooooooo/docmyfiles
• Owner: eliooooooo
• Created: 2024-04-03T16:29:40.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-05-27T15:24:03.000Z (7 months ago)
• Last Synced: 2024-11-06T07:13:43.655Z (about 2 months ago)
• Topics: openai-api, readme-generator, script
• Language: JavaScript
• Homepage:
• Size: 86.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DocMyFiles Project

This project is about generating custom README files using the OpenAI API. It can extract information from project files and create a detailed README based on that data.

## Dependencies

- **dotenv** (^16.4.5)

- **openai** (^4.32.1)

- **fs** (^0.0.1-security)

## Instructions

To run the project, follow these steps:

1. Make sure you have Python installed, as the project uses a Python script to count tokens.

2. Customize the variables in the `docMyFiles.js` file according to your project needs.

3. Set up your OpenAI API key in the `.env` file.

## Project Structure

- **tokenCounter.py** - Python script for counting tokens in the text.

- **docMyFiles.js** - Main JavaScript file for generating the README.

- **.env.exemple** - Example file for storing the OpenAI API key.

## Usage

1. Run the `docMyFiles.js` script.

2. Customize the variables like `projectPath`, `avoid`, and `description` in the script.

3. The script will read project files and create a README based on the extracted information.

4. You can interact with the script to decide whether to send the request to OpenAI for README generation.

---

This README file provides an overview of the project, its dependencies, instructions for running it, and details about the project structure and usage. Feel free to share your impressions !

 This README was generated by [DocMyFiles](https://github.com/eliooooooo/DocMyFiles).