Skip to content

tushar-upadhya/Profile-Read-Maker

Repository files navigation

Profile Readme Maker (PRM)

About

  • Setup: Set up your React project using create-react-app or your preferred method. Install the required dependencies, including react-router-dom and tailwindcss.

  • Create Routing: Use react-router-dom to create routes for different sections of your application, such as the GitHub profile builder and project README builder.

  • GitHub Profile Builder:

    • Create components for different steps of building the GitHub profile.
    • Implement the form fields for user details like name, username, bio, etc.
    • Create toggle buttons for different sections like skills, projects, social links, etc.
    • Add functionality to select badges for skills, languages, frameworks, and more.
    • Preview the GitHub profile in real-time as users make changes.
    • Allow users to customize the style of badges using Tailwind CSS classes.
  • Project README Builder:

    • Create components for different steps of building the project README.
    • Implement form fields for project details like title, description, features, installation instructions, etc.
    • Allow users to add badges, code snippets, screenshots, and other media.
    • Preview the project README in real-time as users make changes.
    • Use Tailwind CSS classes to style the project README components.

Screenshots

![screenshot]Screenshot 2023-08-18 235224 () ![screenshot]Screenshot 2023-08-18 235232 () ![screenshot](Screenshot 2023-08-18 235701 ) ![screenshot](Screenshot 2023-08-18 235709 )

Tech Stack

HTML5 JavaScript NPM React React Router TailwindCSS Git GitHub