🤖 ReadmeAI 📃

Overview

The README Generator is a platform that allows users to upload a single-file code and describe their project. The AI generates a Markdown code, which can be edited in real-time using a code editor, and the changes are previewed instantly.

ReadMeAI is now live at readmeai.live

Navigation

• 🤖 ReadmeAI 📃
  • Overview
  • Navigation
  • 😎 Features
  • 📂 File Structure (MVC)
  • 💻 Tech Stack
  • ⚙️ Installation
    • In Your Local Machine
    • In Your Virtual Machine (using Docker)
  • 🚀 Usage
    • In your Local Machine
    • Using Docker Container
  • 🔮 Features for next release.
  • 🤝Support
  • ✍️ Authors

😎 Features

• AI-Powered Content: It uses Google AI to generate meaningful and informative content for your README, including project description, usage, installation, and more.

• Customization: You can customize the generated content using a built in editor to include or exclude specific sections, ensuring your README reflects your project's unique needs.

• Markdown Support: The generated README files use Markdown, making it easy to format and style your project documentation.

• User-Friendly Web Interface: Access the generator through a user-friendly web interface, eliminating the need for manual setup.

📂 File Structure (MVC)

• 📁 api/ : contains code file to connect to third party api's (Google PaLM 2)
• 📁 controllers/ : Contains all the business logic to execute on post/get requests.
• 📁 views/ : Contains files to render at client sides.
• 📁 data/ : Contains the 'template' which will hold the output template and 'output.md' which will output markdown.
• 📁 public/ : Contains client side css and scripts.
• 📁 routes/ : File to handle routes and to call respective controller function on particular route.
• 📁 uploads/ : This directory will hold files that server received from client side, and then deletes them once the session ends.
• 📃 server.js : This file is the main express server, this is the file that will execute on starting server.
• 📃 Dockerfile : This file contains script to containerize project.

💻 Tech Stack

• 🚀 Node.js: Server-side runtime.
• 🌐 Express: Node.js framework.
• 🤖 Google PaLM API: Google Pathways Language Model is a 540 billion parameter transformer-based large language model.
• 🎨 EJS: Templating engine to render and add dynamic content in your HTML at server.
• 🎨 CSS: Styling the HTML template.
• 💼 JavaScript: To add Interactivity in the frontend.

⚙️ Installation

In Your Local Machine

1. Clone the repository.
2. Navigate to the project directory.
3. Open your terminal and run:

    npm install

In Your Virtual Machine (using Docker)

1. Clone the repo and navigate to the project directory.
2. Open the terminal and type the following command:

     docker build -t gitax18/readmeai .

🚀 Usage

In your Local Machine

1. Change to the project directory.
2. Open your terminal and type the following command:

    npm start

3. The Application will run on http://localhost:3333

Using Docker Container

1. To start the container, type the following command:

    docker run -it -p 3333:3333 gitax18/readmeai

2. Now the Application will run on http://localhost:3333

NOTE: If the project don't run properly and show crbug error in web console then follow following steps.

1. Open VSCode an go to 'Run and Debug' menu in left sidebar.
2. Click on 'create a launch.json file' and select node.js in pop-up menu.
3. Now click on green triangular play icon on the top of same 'Run and Debug' sidebar.
4. Now go to http://localhost:3333

🔮 Features for next release.

• GitHub Authorization to add repo rather than single file.
• More trained AI to generate readme for folders rather than file.
• Custom templates, User can defined what features/section they want in their readme.

🤝Support

If you encounter any issues or have questions, please feel free to create an issue on the repository. We're here to help!

✍️ Authors

• Gitanshu Sankhla (Backend Developer) -

  

• Vijay Banjara (Frontend Developer) -
  

• Harsh Kumar (Designer) -