{"id":24499573,"url":"https://github.com/opensass/nano-og","last_synced_at":"2025-06-20T18:10:23.266Z","repository":{"id":266472518,"uuid":"897928608","full_name":"opensass/nano-og","owner":"opensass","description":"🦞 A Blazingly Fast 🚀 AI-powered Open Graph Image Generator","archived":false,"fork":false,"pushed_at":"2025-03-03T10:46:51.000Z","size":1411,"stargazers_count":4,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-01T00:01:46.018Z","etag":null,"topics":["api","axum","deployment","dioxus","dioxus-fullstack","gemini","gemini-nano","gemini-nano-in-chrome","pinata","pinata-api","pinata-ipfs","rust"],"latest_commit_sha":null,"homepage":"https://opensass.org/nanoog","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensass.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-03T13:42:20.000Z","updated_at":"2025-02-16T19:14:49.000Z","dependencies_parsed_at":"2024-12-04T13:36:03.123Z","dependency_job_id":null,"html_url":"https://github.com/opensass/nano-og","commit_stats":null,"previous_names":["opensass/nano-og"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensass%2Fnano-og","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensass%2Fnano-og/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensass%2Fnano-og/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensass%2Fnano-og/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensass","download_url":"https://codeload.github.com/opensass/nano-og/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253774584,"owners_count":21962199,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","axum","deployment","dioxus","dioxus-fullstack","gemini","gemini-nano","gemini-nano-in-chrome","pinata","pinata-api","pinata-ipfs","rust"],"created_at":"2025-01-21T22:14:51.117Z","updated_at":"2025-05-12T16:16:01.471Z","avatar_url":"https://github.com/opensass.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# 🌌 Nano OG 🎨\n\n[![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-1f425f.svg?logo=rust\u0026logoColor=white)](https://www.rust-lang.org/)\n[![Rust](https://img.shields.io/badge/Rust-1.79%2B-blue.svg)](https://www.rust-lang.org)\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/nano-og)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\n[![Open SASS Discord](https://dcbadge.limes.pink/api/server/b5JbvHW5nv)](https://discord.com/invite/b5JbvHW5nv)\n\n| 🐧 Linux `(Recommended)` | 🪟 Windows |\n| :------: | :------: |\n| [**Download Executable**](https://github.com/opensass/nano-og/releases/download/v0.0.1/dist.zip) | [**Download Executable**](https://github.com/opensass/nano-og/releases/download/v0.0.1/dist.rar) |\n| [**Set Environment Variables**](https://github.com/opensass/nano-og#-setting-up-env-vars) | [**Set Environment Variables**](https://github.com/opensass/nano-og#-setting-up-env-vars) |\n| unzip files | unzip files |\n| execute `./dist/nano-og` | execute `.\\dist\\nano-og.exe` |\n\n\u003c/div\u003e\n\n## 📐 Architecture\n\n![Arch](https://github.com/user-attachments/assets/9f4da22c-729e-40fd-a4c2-c1e57a8f503d)\n\n## 📸 Demo\n\n| 🐧 Linux `(Recommended)` | 🪟 Windows |\n| :------: | :------: |\n| \u003cvideo src=\"https://github.com/user-attachments/assets/04bee24e-58a8-4845-8eff-bbdeefe3a6af\"\u003e\u003c/video\u003e | \u003cvideo src=\"https://github.com/user-attachments/assets/f129e604-460d-4664-8dc4-921045c7e3e5\"\u003e\u003c/video\u003e |\n\n## 🚀 About Nano OG\n\n**Nano OG** is a blazing-fast, AI-powered tool for generating **Open Graph (OG)** images, empowering developers, marketers, and designers to create eye-catching visuals optimized for social media and SEO.\n\nWith support for real-time previews, customizable designs, and developer-friendly APIs, Nano OG takes the hassle out of crafting stunning OG images.\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e Nano OG leverages **Gemini Nano**, which is currently only supported on Windows:\n\u003e \n\u003e 1. **Google Chrome Canary**: Ensure you have the latest version of [**Chrome Canary**](https://www.google.com/chrome/canary/) installed on your machine.\n\u003e 2. **Gemini Nano AI Model**: Make sure the latest Gemini AI weights are downloaded to avoid compatibility issues.\n\u003e \n\n## 🖥️ Pre-Built Binaries\n\nPrefer downloading a ready-to-go binary? We've got you covered! Grab the pre-compiled binaries for your platform from the links above and get started immediately.\n\n\u003e **⚡ Key Features of Pre-Built Binaries:**\n\u003e\n\u003e - Ready-to-use `.exe` or Linux binary.\n\u003e - Simple setup for environment variables.\n\u003e - Optimized for speed and ease of use.\n\n## 🤓 For the Hardcore Nerds\n\nPrefer compiling everything from scratch? Here's what you'll need to get started.\n\n### 🛠️ Prerequisites\n\n1. **Install `rustup`**:\n\n   ```sh\n   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n   ```\n\n1. **Install `Dioxus CLI`**:\n\n   ```sh\n   cargo install dioxus-cli\n   ```\n\n1. **Clone the Repository**:\n\n   ```sh\n   git clone https://github.com/opensass/nano-og.git\n   cd nano-og\n   ```\n\n## 🔑 Setting Up Env Vars\n\nBefore running Nano OG, configure the necessary environment variables for external services like **MongoDB** and **Pinata**.\n\n### Create an `.env` File\n\nIn the project root, copy the example `.env` file:\n\n```sh\ncp .env.example .env\n```\n\nEdit the `.env` file with your credentials:\n\n```sh\nMONGODB_USR=your-mongodb-user\nMONGODB_PWD=your-mongodb-password\nMONGODB_CLSTR=your-cluster.mongodb.net\nMONGODB_DB_NAME=nano-ogs\nJWT_SECRET=your-jwt-secret\nPINATA_API_KEY=your-pinata-api-key\nPINATA_API_SECRET=your-pinata-api-secret\n```\n\n- **MongoDB**: Follow [this guide](./MongoDB.md) to set up and connect your database.\n- **JWT Secret**: Generate a secure key using OpenSSL:\n\n   ```sh\n   openssl rand -hex 128\n   ```\n\n- **Pinata API**: Get your API keys from [Pinata's developer portal](https://pinata.cloud/).\n\n## 🚀 Building and Running\n\nOnce the environment is set up, you're ready to build and run Nano OG.\n\n### Build the Client\n\n```sh\ndx serve\n```\n\nNavigate to [http://localhost:3000](http://localhost:3000) to access Nano OG.\n\n## ✅ Features\n\n- **AI-Powered Generation**: Leverage Genini Nano AI for local and fast, high-quality OG images.\n- **Customizable Designs**: Tailor images to fit your brand perfectly.\n- **Real-Time Previews**: Instant updates as you tweak designs.\n- **Lightning-Fast Backend**: Built with Rust for high performance.\n- **Secure Storage**: Data is stored safely using MongoDB and JWT authentication.\n\n## 🛠️ Tech Stack\n\n- **Axum**: Rust Backend for performance and security.\n- **Dioxus**: Fast, reactive rusty UI framework.\n- **MongoDB**: Flexible, scalable data storage.\n- **Pinata API**: Simplified media uploads to IPFS.\n\n## 📜 License\n\nNano OG is licensed under the [MIT License](./LICENSE).\nFeel free to use, modify, and distribute this project within the terms of the license.\n\n## 💬 Need Help?\n\nJoin the conversation on [Discord](https://discord.com/invite/b5JbvHW5nv) or open an issue on [GitHub](https://github.com/opensass/nano-og/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensass%2Fnano-og","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensass%2Fnano-og","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensass%2Fnano-og/lists"}