Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 2.16 KB

README.md

File metadata and controls

68 lines (39 loc) · 2.16 KB
Raw

IMG-5915.png

gitNarrator

gitNarrator is a React application that generates well-crafted articles about GitHub projects based on user input. It leverages the power of Google's Gemini AI to generate high-quality content about the specified project.

Features

  • Search Bar: A user-friendly search bar at the bottom of the screen allows users to query for articles about GitHub projects.
  • AI-Powered Content Generation: The application utilizes Google's Gemini AI to generate comprehensive articles about the requested GitHub project.
  • Project URL Support: Users can include the project's GitHub URL in their query to ensure the article is written about the correct project.
  • Subtopic Support: Users can specify subtopics they want the article to cover, allowing for more focused and relevant content.

Installation

To run the gitNarrator app locally, follow these steps:

Clone the repository:

git clone https://github.com/codesmith-emmy/gitNarrator.git

Navigate to the project directory:

cd gitNarrator

Install the dependencies:

npm install

Start the development server:

npm start

The app should now be running on http://localhost:3000.

Contributing

This app is still under development and contributions are always welcome! If you'd like to add a new feature or report a bug, please follow these steps:

  • Fork the repository.
  • Create a new branch for your feature or bug fix.
  • Make your changes and commit them with descriptive commit messages.
  • Push your changes to your forked repository.
  • Submit a pull request to the main repository.

Please make sure to follow the project's code of conduct and refer to the Contributing.md file for more details.

License

gitNarrator is licensed under the MIT License.

Acknowledgments

gitNarrator is powered by Google's Gemini AI, a powerful language model that enables the generation of high-quality content.