LikeME is an open-source project that allows you to add a like button to your GitHub profile README. With just one click, visitors can show their appreciation for your profile, and you can display dynamic badges showcasing your likes. Built with Nuxt.js, TypeScript, Tailwind CSS, and Prisma.
- 🚀 Quick Start
- ✨ Features
- 🔧 Configuration
- 🤝 Contributing
- 🐛 Bug Reports
- 💡 Feature Requests
- 📑 General Issues
- ❓ FAQ
- 🏆 Acknowledgments
- 📄 License
- 📞 Contact
# Clone the repository
git clone https://github.com/feeeedox/likeme.git
# Navigate to project directory
cd likeme
# Install dependencies
yarn install
# Start the development server
yarn dev♥️ Like System - Let people like your GitHub profile with one click- 🎨 Beautiful Badges - Dynamic SVG badges showing your likes, bio, and stats
- 👤 User Profiles - Personal dashboard to manage your profile and bio
- 📊 Like Analytics - See who likes you and track your popularity
- 🔐 GitHub OAuth - Secure authentication via GitHub
- ⚡ Fast Performance - Optimized with caching and efficient queries
- 🎯 Easy Integration - Add to your README with one line of code
- 🇩🇪 Legal Compliance - GDPR-compliant with German Imprint & Privacy Policy
- 🗑️ Data Control - Delete your account and data anytime
Create a .env file in the root directory:
# Database (connect to your external MySQL/MariaDB instance)
DATABASE_URL=mysql://user:password@your-db-host:3306/likeme
# GitHub OAuth
NUXT_OAUTH_GITHUB_CLIENT_ID=your_github_client_id
NUXT_OAUTH_GITHUB_CLIENT_SECRET=your_github_client_secret
# Session Secret (generate with: openssl rand -base64 32)
NUXT_SESSION_PASSWORD=password-with-at-least-32-charactersContributions are very welcome! Here's how you can help:
- Fork the repository
- Create a feature branch
git checkout -b feature/amazing-feature
- Make your changes
- Add tests for your changes
- Commit your changes
git commit -m 'Add: amazing feature' - Push to the branch
git push origin feature/amazing-feature
- Open a Pull Request
- Follow the existing code style
- Write tests for new features
- Update documentation as needed
- Use conventional commit messages
- Ensure all tests pass before submitting
- Use 4 spaces for indentation (like you prefer! 😊)
- Use meaningful variable names
- Add comments for complex logic
- Follow the project's ESLint configuration
# Fork and clone the repository
git clone https://github.com/feeeedox/likeme.git
# Install dependencies
yarn install
# Start development server
yarn devFound a bug? Please use our 🐛 Bug Report template when creating an issue.
- 🐞 Description – What exactly went wrong?
- 🔁 Steps to Reproduce – How can we replicate the bug?
- ✅ Expected Behavior – What should have happened instead?
- 📸 Screenshots – If possible, add screenshots or GIFs
- 🖥️ Environment – OS, browser, Node.js version, project version
- ➕ Additional Context – Any extra info that could help
👉 Create a new bug report here: New Bug Report
Got an idea for improvement? Use our 💡 Feature Request template to share it.
- ✨ Feature Description – What should be added/changed?
- 🎯 Motivation & Problem – Why is this feature valuable?
- 🛠️ Proposed Solution – How could it be implemented?
- 🔄 Alternatives – Any other approaches you considered
- 📸 Mockups / Screenshots – Optional design or concept images
- ➕ Additional Context – Extra notes, links, or references
👉 Submit your idea here: New Feature Request
For discussions, questions, or other ideas, use our 📝 General Issue template.
- 📝 Summary – A clear and concise description of the issue
- 🤔 Context – Why are you opening this issue? (discussion, feedback, question)
- 🎯 Goal – What do you want to achieve with this issue?
- ➕ Additional Notes – Extra details, links, or references
👉 Open a general issue here: New General Issue
My badge is outdated
We have caching in place to reduce server load. Badges are updated every 5 minutes.
Which Node.js version is required?
The project requires Node.js version 20.0 or higher.
How can I contribute to the project?
See the Contributing section for detailed information.
Is the project free of charge?
Yes, the project is open source and available free of charge under the MIT license.
How do I report a bug?
Create an issue in the GitHub repository with a detailed description of the problem.
If you like the project, there are several ways you can support it:
Give the project a star on GitHub!
- Share on social media
- Write a blog post
- Tell your friends and colleagues
If you discover a security vulnerability, please send an email to f3dox@proton.me. All security vulnerabilities will be promptly addressed.
- All dependencies are regularly updated
- Security scanning with automated tools
- Following OWASP guidelines
- Regular security audits
This project is licensed under the MIT License—see the LICENSE file for details.
MIT License
Copyright (c) 2025 Florian Ohldag
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Florian - @feeeedox
- Issues: GitHub Issues
README template generated using better-repo