https://github.com/xeven777/opbento
https://github.com/xeven777/opbento
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/xeven777/opbento
- Owner: Xeven777
- License: gpl-3.0
- Created: 2024-10-24T05:34:50.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-30T10:48:26.000Z (11 months ago)
- Last Synced: 2025-04-15T05:46:45.502Z (6 months ago)
- Language: TypeScript
- Homepage: https://opbento.vercel.app
- Size: 72.9 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🧊 OP Bento
## Transform Your GitHub Profile with a Stunning Bento Grid
**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](https://opbento.edgexhq.tech)** 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](https://opbento.edgexhq.tech/guide) 📚.
---
## 🛠️ 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](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](https://github.com/edgexhq/opbento/blob/main/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
- Subhadeep Roy [@subhadeeproy3902](git.new/Subha)
- Anish Biswas [@Xeven777](git.new/anish)
- Arghya Ghosh [@uiuxarghya](git.new/uiuxarghya)
---
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!