Skip to content

edgexhq/opbento

Repository files navigation

🧊 OP Bento

Transform Your GitHub Profile with a Stunning Bento Grid

screenshot

Add a fresh, dynamic look to your GitHub profile with OP Bento! ✨ OP Bento is an open-source tool that generates a custom bento-style grid for your GitHub profile, showcasing your favorite projects, skills, and recent activity in an eye-catching layout. With automatic updates, your profile stays effortlessly up-to-date.


🎨 Features

  • Customizable Bento Grid: Showcase your social links, github stats, and more in a stylish and functional grid.
  • Automatic Refresh: Daily updates keep your profile fresh with your latest GitHub activity.
  • Simple Setup: Just a few steps to copy and paste, and OP Bento does the rest – no maintenance needed!

📖 Getting Started

Setting up OP Bento is quick and easy! Follow these steps:

  1. Visit OP Bento to fill out your bio, add favorite projects, and customize your profile grid.
  2. Click "Generate" to create your bento setup files:
    • getNewBento.ts: Holds all the code for fetching your GitHub data.
    • update-bento.yml: A GitHub workflow file for automatic updates to your bento grid.
  3. Add the files to your GitHub profile repository.
  4. Update your README.md with the generated bento code, and watch your profile transform!

For a full step-by-step guide, check out our documentation 📚.


🛠️ Tech Stack

  • Next Js
  • TypeScript
  • GitHub Actions
  • TailwindCss
  • Puppeteer
  • Github GraphQL

🤝 Contributing

We’re open-source and welcome contributions! If you’d like to add features or improvements, please read our CONTRIBUTING.md before getting started. Feel free to raise issues, submit pull requests, or suggest ideas – the OP Bento community is here to collaborate and grow!


📜 License

This project is licensed under the GNU License. See the LICENSE file for more information.


🌟 Show Your Support

If you find OP Bento helpful, please give us a ⭐ on GitHub and share it with others!

Enjoy a refreshed GitHub profile with OP Bento! 😎✨

😎 Authors


This README provides a friendly, organized, and visually appealing way to engage new users and contributors. Feel free to update links or sections as you build out OP Bento!