Salamander GitHub Profile ReadMe Maker

Build clean, representable, and engaging GitHub profile READMEs in minutes.

Overview

Salamander GitHub Profile ReadMe Maker is a React/Next.js app that helps developers generate polished GitHub profile README content with badges, social links, GitHub stats, donation support, and profile sections.

Why this project exists

This app helps open-source contributors and community members create a strong GitHub profile README quickly, without needing Markdown expertise.

Features

• Guided multi-step README generation flow
• GitHub stats blocks and summary cards
• Social links support (GitHub, X, LinkedIn, Discord, and more)
• Tech stack badge generation
• Profile extras like donation links and visitor counters
• Built using Next.js, Tailwind CSS, and Firebase

Getting started locally

Prerequisites

• Node.js LTS v18+
• pnpm package manager
• Git

This repository uses pnpm and pnpm-lock.yaml. Prefer pnpm for installs and scripts. Do not mix npm install with this lockfile.

Clone and install

git clone https://github.com/Salamander-Tech-Hub/github-profile-readme-maker.git
cd github-profile-readme-maker
pnpm install

Run the app locally

pnpm dev

Then open: http://localhost:3000

Build and serve production

pnpm build
pnpm start

Useful scripts

pnpm lint    # run ESLint
pnpm dev     # development server
pnpm build   # production build
pnpm start   # serve built app

Troubleshooting

Windows path casing issue

If pnpm dev shows warnings like There are multiple modules with names that only differ in casing, it means the project path is being referenced with different uppercase/lowercase paths.

How to fix:

1. Use one consistent path everywhere (terminal, editor, shortcuts).
2. Prefer the lowercase path used by the current workspace.
3. From that path, run:

rm -rf .next node_modules
pnpm install
pnpm dev

4. Re-open the project in your editor with the same path casing.

Contributing

To help improve this project, please read this README and then follow the guidance in CONTRIBUTING.md for setup, workflow, and PR process.

Community and support

• GitHub: https://github.com/Salamander-Tech-Hub/
• X: https://x.com/Salamander_hub
• LinkedIn: https://www.linkedin.com/company/salamander-tech-hub/posts/?feedView=all

License

This project is licensed under MIT.