GitHub README Generator

This is a web application that allows users to generate a stylish README.md file for their GitHub profiles. It provides a user-friendly form to input personal information, select a template style, choose skills and technologies, and automatically integrate GitHub statistics.

Features

• Personal Information: Input your full name, GitHub username, custom section name, bio, email, Twitter/X handle, and portfolio/website URL.
• Template Selection: Choose from 5 predefined README styles: Professional, Funny, Joke, Mini, and Creative.
• Skills & Technologies: Select your programming languages, frontend, backend & database, and tools & DevOps skills from categorized lists.
• GitHub Stats Integration: Automatically display your GitHub profile statistics, top languages, and streak stats using the Vercel API.
• Real-time Preview: See a live preview of your generated README.md as you fill out the form.
• Copy & Download: Easily copy the generated Markdown content or download it as a README.md file.

Technologies Used

• React: Frontend JavaScript library for building user interfaces.
• Bootstrap: CSS framework for responsive and mobile-first front-end web development.
• React-Hook-Form: For efficient and flexible form management.
• React-Markdown: For rendering Markdown content in React components.

How to Run Locally

To get this project up and running on your local machine, follow these steps:

1. Clone the repository:

   git clone https://github.com/OpenRim/readme-generator.git
   cd readme-generator

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

   The application will be accessible at http://localhost:5173/ (or another port if 5173 is in use).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

This project is built with React and TypeScript. We follow standard coding practices and use ESLint for linting. Please ensure your contributions adhere to these standards.

Creating a Pull Request

1. Fork the Project: Click the 'Fork' button at the top right of the main repository page. This creates a copy of the project in your own GitHub account.

2. Clone Your Fork:

   git clone https://github.com/YOUR_USERNAME/readme-generator.git
   cd readme-generator

3. Create a New Branch: Create a descriptive branch name for your new feature or fix.

   • For a new feature:

     git checkout -b feature/AmazingFeature

   • For a bug fix:

     git checkout -b fix/SomeBug

4. Make Your Changes: Implement your feature or fix the bug.

5. Commit Your Changes: Use a conventional commit message to describe your changes clearly.

   • For a new feature:

     git commit -m 'feat: Add some AmazingFeature'

   • For a bug fix:

     git commit -m 'fix: Correct SomeBug'

6. Push to Your Branch:

   git push origin feature/AmazingFeature

7. Open a Pull Request: Go to the original repository on GitHub and click the 'New pull request' button. Fill out the PR template with a clear description of your changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

• GitHub: zeini-23025
• Email: zeiny.cheikh.dev@gmail.com

⭐ Show your support

If you find this project helpful, please consider giving it a ⭐ to show your support!