π§ Linux (Recommended) |
πͺ Windows |
---|---|
Download Executable | Download Executable |
Set Environment Variables | Set Environment Variables |
unzip files | unzip files |
execute ./dist/nano-og |
execute .\dist\nano-og.exe |
π§ Linux (Recommended) |
πͺ Windows |
---|---|
nano-og-demo.mp4 |
nano-og-windows.mp4 |
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.
With support for real-time previews, customizable designs, and developer-friendly APIs, Nano OG takes the hassle out of crafting stunning OG images.
Important
Nano OG leverages Gemini Nano, which is currently only supported on Windows:
- Google Chrome Canary: Ensure you have the latest version of Chrome Canary installed on your machine.
- Gemini Nano AI Model: Make sure the latest Gemini AI weights are downloaded to avoid compatibility issues.
Prefer 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.
β‘ Key Features of Pre-Built Binaries:
- Ready-to-use
.exe
or Linux binary.- Simple setup for environment variables.
- Optimized for speed and ease of use.
Prefer compiling everything from scratch? Here's what you'll need to get started.
-
Install
rustup
:curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-
Install
Dioxus CLI
:cargo install dioxus-cli
-
Clone the Repository:
git clone https://github.com/opensass/nano-og.git cd nano-og
Before running Nano OG, configure the necessary environment variables for external services like MongoDB and Pinata.
In the project root, copy the example .env
file:
cp .env.example .env
Edit the .env
file with your credentials:
MONGODB_USR=your-mongodb-user
MONGODB_PWD=your-mongodb-password
MONGODB_CLSTR=your-cluster.mongodb.net
MONGODB_DB_NAME=nano-ogs
JWT_SECRET=your-jwt-secret
PINATA_API_KEY=your-pinata-api-key
PINATA_API_SECRET=your-pinata-api-secret
-
MongoDB: Follow this guide to set up and connect your database.
-
JWT Secret: Generate a secure key using OpenSSL:
openssl rand -hex 128
-
Pinata API: Get your API keys from Pinata's developer portal.
Once the environment is set up, you're ready to build and run Nano OG.
dx serve
Navigate to http://localhost:3000 to access Nano OG.
- AI-Powered Generation: Leverage Genini Nano AI for local and fast, high-quality OG images.
- Customizable Designs: Tailor images to fit your brand perfectly.
- Real-Time Previews: Instant updates as you tweak designs.
- Lightning-Fast Backend: Built with Rust for high performance.
- Secure Storage: Data is stored safely using MongoDB and JWT authentication.
- Axum: Rust Backend for performance and security.
- Dioxus: Fast, reactive rusty UI framework.
- MongoDB: Flexible, scalable data storage.
- Pinata API: Simplified media uploads to IPFS.
Nano OG is licensed under the MIT License. Feel free to use, modify, and distribute this project within the terms of the license.
Join the conversation on Discord or open an issue on GitHub.