Skip to content

README.md

Latest commit

 

History

History
42 lines (27 loc) · 1 KB

README.md

File metadata and controls

42 lines (27 loc) · 1 KB

GitHub Profile README Generator

Check demo

This project is a website that has a simple UI where you can input a set of details that you want to include in your README file. Once you're done filling in the inputs, the website generates a markdown that you can copy and paste into your Github profile.

This README generator is a great tool for developers who want to create a professional-looking README file for their Github profile without spending too much time on it. It's easy to use, customizable, and built using modern web technologies.

Tech stack

  • React
  • TypeScript
  • Next.js
  • Primer Design System
  • TailwindCSS

Getting Started

Prerequisites

  • Node.js (version 12 or higher)

Installing

  1. Clone the repository
git clone https://github.com/juniorboos/github-profile-generator.git
  1. Install dependencies
npm install
  1. Run the server
npm run dev

This will start the development server at http://localhost:3000.