├── .gitignore
├── LICENSE
├── README.md
├── next-env.d.ts
├── next.config.ts
├── package.json
├── pages
├── _app.tsx
├── api
│ └── avatar
│ │ └── [name].tsx
└── index.tsx
├── pnpm-lock.yaml
├── public
└── favicon.ico
├── styles
├── Home.module.css
└── globals.css
├── tsconfig.json
└── utils
└── gradient.ts
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.log
3 | test.html
4 |
5 | .next
6 | .DS_Store
7 | .vercel
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2017 Tobias Lins
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6 |
7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8 |
9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # avatar     
2 |
3 | Generate beautiful gradient avatars for your application.
4 |
5 | ## Usage
6 |
7 | Provide a username to generate an avatar. Each name will generate a unique `avatar`. Just replace `rauchg` with an `username` or `email`:
8 |
9 | ```
10 | https://avatar.vercel.sh/rauchg
11 | ```
12 |
13 | You will receive a `png` image with a size of 120\*120px
14 |
15 | 
16 |
17 | ### Adjust Roundness
18 |
19 | ```
20 | https://avatar.vercel.sh/rauchg?rounded=60
21 | ```
22 |
23 | 
24 |
25 | ### Custom Size
26 |
27 | ```
28 | https://avatar.vercel.sh/rauchg?size=30
29 | ```
30 |
31 | 
32 |
33 | ### SVG
34 |
35 | Add the extension `.svg`:
36 |
37 | ```
38 | https://avatar.vercel.sh/rauchg.svg
39 | ```
40 |
41 | ### Add Initials
42 |
43 | Add the `text` parameter (requires SVG):
44 |
45 | ```
46 | https://avatar.vercel.sh/rauchg.svg?text=GR
47 | ```
48 |
49 | 
50 |
--------------------------------------------------------------------------------
/next-env.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 | ///
3 |
4 | // NOTE: This file should not be edited
5 | // see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.
6 |
--------------------------------------------------------------------------------
/next.config.ts:
--------------------------------------------------------------------------------
1 | import type { NextConfig } from 'next'
2 |
3 | const nextConfig: NextConfig = {
4 | reactStrictMode: true,
5 | async rewrites() {
6 | return [
7 | {
8 | source: '/:path*',
9 | destination: '/api/avatar/:path*',
10 | },
11 | ]
12 | },
13 | }
14 |
15 | export default nextConfig
16 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "avatar",
3 | "version": "0.1.0",
4 | "private": true,
5 | "packageManager": "pnpm@9.10.0+sha512.73a29afa36a0d092ece5271de5177ecbf8318d454ecd701343131b8ebc0c1a91c487da46ab77c8e596d6acf1461e3594ced4becedf8921b074fbd8653ed7051c",
6 | "scripts": {
7 | "dev": "next dev --turbopack",
8 | "build": "next build",
9 | "start": "next start",
10 | "lint": "next lint"
11 | },
12 | "dependencies": {
13 | "@types/node": "22.10.5",
14 | "@types/react": "19.0.2",
15 | "@types/react-dom": "19.0.2",
16 | "next": "15.2.4",
17 | "react": "19.0.0",
18 | "react-dom": "19.0.0",
19 | "tinycolor2": "^1.6.0",
20 | "typescript": "5.7.2"
21 | },
22 | "devDependencies": {
23 | "@types/tinycolor2": "^1.4.6"
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/pages/_app.tsx:
--------------------------------------------------------------------------------
1 | import '../styles/globals.css'
2 | import type { AppProps } from 'next/app'
3 |
4 | export default function App({ Component, pageProps }: AppProps) {
5 | return
6 | }
7 |
--------------------------------------------------------------------------------
/pages/api/avatar/[name].tsx:
--------------------------------------------------------------------------------
1 | import { ImageResponse } from 'next/og'
2 | import type { NextRequest } from 'next/server'
3 | import { renderToReadableStream } from 'react-dom/server'
4 | import { generateGradient } from '../../../utils/gradient'
5 |
6 | export const runtime = 'edge'
7 |
8 | export default async function handler(req: NextRequest) {
9 | const searchParams = req.nextUrl.searchParams
10 | const name = searchParams.get('name')
11 | const text = searchParams.get('text')
12 | const size = Number(searchParams.get('size') || '120')
13 | const rounded = Number(searchParams.get('rounded') || '0')
14 |
15 | const [username, type] = name?.split('.') || []
16 | const fileType = type?.includes('svg') ? 'svg' : 'png'
17 |
18 | const gradient = await generateGradient(username || `${Math.random()}`)
19 |
20 | const avatar = (
21 |
60 | )
61 |
62 | if (fileType === 'svg') {
63 | const stream = await renderToReadableStream(avatar)
64 | return new Response(stream, {
65 | headers: {
66 | 'Content-Type': 'image/svg+xml',
67 | 'Cache-Control': 'public, max-age=604800, immutable',
68 | },
69 | })
70 | }
71 |
72 | return new ImageResponse(avatar, {
73 | width: size,
74 | height: size,
75 | })
76 | }
77 |
--------------------------------------------------------------------------------
/pages/index.tsx:
--------------------------------------------------------------------------------
1 | import Head from 'next/head';
2 | import Image from 'next/image';
3 | import styles from '../styles/Home.module.css';
4 |
5 | export default function Home() {
6 | return (
7 |
8 |
9 |
Vercel Avatar
10 |
11 |
12 |
13 |
14 |
15 | Avatar
16 |
17 |
27 |
28 |
29 |
41 |
23 | 
24 | 
25 | 
26 |