🌟 Features
- SVG Emoji Generation - Generates an SVG image containing the requested emoji.
- PNG Emoji Generation - Creates a PNG image using the canvas module with custom fonts for emojis.
- GIF Emoji Fetching - Fetches and serves emoji GIFs directly from a reliable source.
- Random Format Response - Allows users to get a random emoji format (SVG, PNG, or GIF) with just one request.
- Fallbacks for Missing Emojis - In case an emoji isn't found, the app uses a default emoji (💩) to ensure smooth operation.
🔄 Routes
- /svg/:emoji - Generates an SVG image of the requested emoji. Example: /svg/❤️
- /png/:emoji - Generates a PNG image of the requested emoji. Example: /png/💻
- /gif/:emoji - Fetches the emoji GIF from a reliable source. Example: /gif/😂
- /:emoji - Returns a random image format (SVG, PNG, or GIF) for the requested emoji. Example: /😊
🧑💻 Stack
- Hono - A minimal web framework for building APIs.
- Deno - JavaScript and TypeScript runtime.
- Canvas - For generating PNG images with custom fonts.
- Emoji Regex - To detect and extract emojis from strings.
- NotoColorEmoji-Regular.ttf - Font for rendering emojis.
🛠 Installation
You can add emoji-route with one command via:
npm i
💻 Contributing
We welcome contributions to improve emoji-route! If you have suggestions, bug fixes, or new feature ideas, follow these steps:
- Fork the Repository - Click the Fork button at the top-right of the repo page.
-
Clone Your Fork - Clone the repo locally:
git clone https://github.com/ArnavK-09/emoji-route.git
-
Create a Branch - Create a new branch for your
changes:
git checkout -b your-feature-branch
- Make Changes - Implement your changes (bug fixes, features, etc.).
-
Commit and Push - Commit your changes and push the
branch:
git commit -m "feat(scope): description"
- Open a Pull Request - Open a PR with a detailed description of your changes.
- Collaborate and Merge - The maintainers will review your PR, request changes if needed, and merge it once approved.
🙋♂️ Issues
Found a bug or need help? Please create an issue on the GitHub repository with a detailed description.
👤 Author
![]() Arnav K |
💖 Thanks for Using emoji-route!
If you find this project helpful, please give it a ⭐ on GitHub!