https://github.com/TheShiveshNetwork/readmekraft
Craft Perfect GitHub Markdown Files with AI
https://github.com/TheShiveshNetwork/readmekraft
hacktoberfest hacktoberfest-accepted
Last synced: 13 days ago
JSON representation
Craft Perfect GitHub Markdown Files with AI
- Host: GitHub
- URL: https://github.com/TheShiveshNetwork/readmekraft
- Owner: TheShiveshNetwork
- License: gpl-2.0
- Created: 2024-07-29T22:43:38.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T21:09:58.000Z (6 months ago)
- Last Synced: 2024-11-02T16:08:51.091Z (5 months ago)
- Topics: hacktoberfest, hacktoberfest-accepted
- Language: TypeScript
- Homepage: https://readmekraft.vercel.app
- Size: 2.72 MB
- Stars: 21
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - TheShiveshNetwork/readmekraft - Craft Perfect GitHub Markdown Files with AI (TypeScript)
README
[![Contributors][contributors-shield]](https://github.com/TheShiveshNetwork/readmekraft/graphs/contributors)
[![Forks][forks-shield]](https://github.com/TheShiveshNetwork/readmekraft/forks)
[![Stargazers][stars-shield]](https://github.com/TheShiveshNetwork/readmekraft/stargazers)
[![Issues][issues-shield]](https://github.com/TheShiveshNetwork/readmekraft/issues)
[![GPL-2.0 License][license-shield]](https://github.com/TheShiveshNetwork/readmekraft?tab=GPL-2.0-1-ov-file#readme)
Table of Contents
## About The Project
Here's an overview of what the READMEKRAFT project looks like:
[
](https://github.com/Code-Hacker26/readmekraft/blob/8d4be02b9e132f17b0c082c88b324327e3f0677b/public/assets/home.png)
**READMEKRAFT** is a powerful tool designed to help developers create comprehensive and professional README files for their projects. Whether you're working on a small open-source project or a large enterprise application, READMEKRAFT provides a streamlined way to generate, edit, and maintain your project documentation.
### Built With
This section lists the major frameworks, libraries, and tools used to build READMEKRAFT:
* [![Next][Next.js]][Next-url]
* [![React][React.js]][React-url]
* [![JavaScript][JavaScript]][JavaScript-url]
* [![TypeScript][TypeScript]][TypeScript-url]
* [![Node.js][Node.js]][Node-url]
* [![Tailwind CSS][Tailwind.css]][Tailwind-url]
* [![Vercel][Vercel]][Vercel-url]
## Getting Started
To get a local copy up and running, follow these simple steps.
### Prerequisites
Before you begin, ensure you have met the following requirements:
* Node.js and npm installed.
```sh
npm install npm@latest -g
```
### Installation
Follow these steps to install and set up READMEKRAFT:
1. **Clone the Repository:**
```sh
git clone https://github.com/TheShiveshNetwork/READMEKRAFT.git
```
2. **Navigate into the Project Directory:**
```sh
cd READMEKRAFT
```
3. **Install NPM Packages:**
```sh
npm install
```
4. **Get Gemini API Key:**
Visit the Gemini API documentation
to generate an API key.
5. **Create .env.local File:**
In the root of your project directory, create a file named .env.local.
Paste your Gemini API key in the following format:
```sh
NEXT_PUBLIC_GEMINI_API=your_api_key_here
```
4. **Run the Development Server:**
```sh
npm run dev
```
5. **Open Your Browser:**
Navigate to http://localhost:3000 to see the application running.
## Usage
Here are some examples of how to use READMEKRAFT:
### Basic Usage
To get started with READMEKRAFT, you can follow these simple examples:
1. **Starting the Development Server:**
```sh
npm run dev
```
# or
```sh
yarn dev
```
# or
```sh
pnpm dev
```
# or
```sh
bun dev
```
## Contributing
Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make to READMEKRAFT are **greatly appreciated**.
If you have an idea for improving the project, please fork the repository and create a pull request. You can also open an issue with the "enhancement" tag to start a discussion.
For detailed guidelines on contributing, please refer to the [CONTRIBUTION_GUIDELINES.md](https://github.com/TheShiveshNetwork/readmekraft/blob/main/CONTRIBUTING.md) file.
### Steps to Contribute:
1. **Fork the Project**
Click the "Fork" button at the top right of the repository page to create your own copy of the project.
2. **Clone the Forked Repository**
Once you have forked the project, clone it to your local machine:
```sh
git clone https://github.com/your-username/READMEKRAFT.git
```
3. **Create a New Branch**
Create a branch for your feature or fix:
```sh
git checkout -b feature/YourFeatureName
```
4. **Commit Your Changes**
Commit your changes with a clear and descriptive message:
```sh
git commit -m 'Add feature: YourFeatureName'
```
5. **Push to Your Branch**
Push the changes to your forked repository:
```sh
git push origin feature/YourFeatureName
```
6. **Open a Pull Request**
Navigate to the original repository, and click the "New Pull Request" button.
From there, select your forked repository and the branch with your changes.
Submit the pull request for review.
## License
Distributed under the GPL-2.0 License. See [`LICENSE.txt`](./LICENSE) for more information.
## Contact
Project Link: [https://github.com/TheShiveshNetwork/READMEKRAFT](https://github.com/TheShiveshNetwork/READMEKRAFT)
## Acknowledgments
We'd like to give credit to the following resources and tools that have been invaluable in the development of READMEKRAFT:
* [Next.js Documentation](https://nextjs.org/docs) - Comprehensive documentation for Next.js.
* [React Documentation](https://reactjs.org/docs/getting-started.html) - Official React documentation.
* [Tailwind CSS Documentation](https://tailwindcss.com/docs) - Detailed guides and documentation for Tailwind CSS.
* [JavaScript Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript) - Detailed guides and documentation for JavaScript.
* [TypeScript Documentation](https://www.typescriptlang.org/docs/) - Comprehensive resources and guides for TypeScript.
* [Vercel Documentation](https://vercel.com/docs) - Resources and guides for deploying with Vercel.
* [Shields.io](https://shields.io) - Badges for GitHub repositories.
* [Font Awesome](https://fontawesome.com) - Icons and toolkits for web development.
* [React Icons](https://react-icons.github.io/react-icons) - A library of icons for React applications.
[contributors-shield]: https://img.shields.io/github/contributors/TheShiveshNetwork/READMEKRAFT.svg?style=for-the-badge
[contributors-url]: https://github.com/TheShiveshNetwork/READMEKRAFT/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/TheShiveshNetwork/READMEKRAFT.svg?style=for-the-badge
[forks-url]: https://github.com/TheShiveshNetwork/READMEKRAFT/network/members
[stars-shield]: https://img.shields.io/github/stars/TheShiveshNetwork/READMEKRAFT.svg?style=for-the-badge
[stars-url]: https://github.com/TheShiveshNetwork/READMEKRAFT/stargazers
[issues-shield]: https://img.shields.io/github/issues/TheShiveshNetwork/READMEKRAFT.svg?style=for-the-badge
[issues-url]: https://github.com/TheShiveshNetwork/READMEKRAFT/issues
[license-shield]: https://img.shields.io/github/license/TheShiveshNetwork/READMEKRAFT.svg?style=for-the-badge
[license-url]: https://github.com/TheShiveshNetwork/READMEKRAFT/blob/master/LICENSE
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Node.js]: https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=white
[Node-url]: https://nodejs.org/
[JavaScript]: https://img.shields.io/badge/JavaScript-F7DF1C?style=for-the-badge&logo=javascript&logoColor=black
[JavaScript-url]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
[TypeScript]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white
[TypeScript-url]: https://www.typescriptlang.org/
[Tailwind.css]: https://img.shields.io/badge/Tailwind_CSS-06B6D4?style=for-the-badge&logo=tailwind-css&logoColor=white
[Tailwind-url]: https://tailwindcss.com/
[Vercel]: https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white
[Vercel-url]: https://vercel.com/