© Open Dev Society. This project is licensed under AGPL-3.0; if you modify, redistribute, or deploy it (including as a web service), you must release your source code under the same license and cre[...]

OpenReadme

OpenReadme is a modern, open-source GitHub profile README generator that creates beautiful, customizable bento-style grids. Built with Next.js and serverless technology, it allows you to create stunning profile README banners.

Note: Workflow automation and auto-updating features are currently under development. For now, OpenReadme supports only static image creation.

---

📋 Table of Contents

1. ✨ Introduction
2. 🌍 Open Dev Society Manifesto
3. ⚙️ Tech Stack
4. 🔋 Features
5. 🤸 Quick Start
6. 🐳 Docker Setup
7. 🔐 Environment Variables
8. 🧱 Project Structure
9. 📡 API & Integrations
10. 🧪 Scripts & Tooling
11. 🤝 Contributing
12. 🛡️ Security
13. 📜 License
14. 🙏 Acknowledgements

---

✨ Introduction

OpenReadme is a cutting-edge GitHub profile README generator powered by Next.js (App Router), Tailwind CSS, and serverless Chromium for dynamic image generation. Create stunning profile banners for your GitHub README with ease.

Currently, OpenReadme supports static image generation only, and the auto-updating workflow feature is in progress.

---

🔋 Features

• 🎨 Profile Generation

  • Beautiful bento-style grid layouts
  • Customizable profile information display
  • Social media integration (GitHub, Twitter, LinkedIn)
  • Portfolio and website links

• 🔄 Auto-Updates (Upcoming)

  • GitHub Actions workflow generation
  • Scheduled profile image updates
  • Real-time GitHub stats integration
  • Automatic cache invalidation

• ⚡ Current Functionality

  • Static image generation through the RESTful API
  • Simplified and lightweight setup for immediate use

• 🌐 API-First Design

  • RESTful image generation API
  • Query parameter customization
  • Serverless architecture
  • Optimized image delivery

• 📱 Modern UI

  • Responsive design
  • Dark theme optimized
  • Smooth animations
  • Intuitive user experience

• 🔧 Developer Experience

  • TypeScript support
  • ESLint configuration
  • Hot reload development
  • Production-ready builds

---

🤸 Quick Start

Prerequisites

• Node.js 18+
• Git for version control

Clone and Install

git clone https://github.com/Open-Dev-Society/openreadme.git
cd openreadme

# Choose your package manager
npm install
# or
yarn install
# or
pnpm install

Configure Environment

• Create a .env.local file (see Environment Variables)

Run Development

npm run dev
# or
yarn dev
# or
pnpm dev

Build & Start (Production)

npm run build && npm start
# or
yarn build && yarn start
# or
pnpm build && pnpm start

Open http://localhost:3000 to start creating your OpenReadme!

---

🔐 Environment Variables

Create .env.local at the project root:

# Core Configuration
NODE_ENV=development

# GitHub Integration (Future Use)
GITHUB_TOKEN=ghp_your_personal_access_token_here

# Optional: Local Development
CHROME_EXECUTABLE_PATH=  # Optional for local Chromium path

Security Notes

• Keep private tokens server-side when possible
• Use environment-specific configurations
• Never commit sensitive credentials to version control
• Consider using secure environment management tools

---

📜 License

OpenReadme is and will remain free and open for everyone. This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.

---

🙏 Acknowledgements

Special thanks to the open-source community and all contributors who make OpenReadme possible. Your support drives us forward as we work on the upcoming features.

---

Built with ❤️ by Open Dev Society