Skip to content

rabiibouhestine/github-profile-maker

Repository files navigation

GitHub Profile Maker

A minimal README maker that lets users easily generate a GitHub profile README using customizable sections.

Live demo: github.rabii.dev


Table of Contents


Features

  • Customizable sections (e.g. Text, Image, Badges, Trophies, Stats)
  • Live preview of the README as you build it
  • Download the generated Markdown file or Copy to clipboard
  • Intuitive UI for users to build a profile README
  • Lightweight and minimal dependencies

Installation / Running Locally

  1. Clone the repo:
git clone https://github.com/rabiibouhestine/github-profile-maker.git
cd github-profile-maker
  1. Install dependencies:
npm install
# or
yarn install
  1. Run in development mode:
npm run dev
# or
yarn dev
  1. Open your browser at http://localhost:5173 (or as indicated) to use the tool.

Technologies Used

  • React (with TypeScript)
  • Vite for bundling / dev server
  • Tailwind CSS and shadcn for Styling
  • dndkit for Drag and Drop
  • framer motion for Animations

License

This project is licensed under the MIT License

About

A minimal readme maker that allows users to easily create a Github profile readme file using customisable sections.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages