📦 Extensions

A list of extensions that use the SVGL API, created by the community:

🛠️ Stack

• Sveltekit + Svelte 5 - Web development, streamlined.
• Typescript - JavaScript with syntax for types.
• Content-Collections - Transform your content into type-safe data collections and say goodbye to manual data fetching and parsing.
• Shiki - A beautiful Syntax Highlighter.
• Tailwind CSS - A utility-first CSS framework for rapidly building custom designs.
• bits-ui - A collection of headless components for Svelte.
• clsx + tailwind-merge inspired by shadcn/ui - A tiny utility for constructing className strings conditionally.
• Prettier + prettier-plugin-tailwindcss - An opinionated code formatter.
• Lucide Icons - Beautiful & consistent icons.
• svelte-sonner - An opinionated toast component for Svelte.
• Express with Redis - A fast, unopinionated, minimalist web framework for Node.js with a powerful in-memory data structure store.

🚀 Getting Started

[!IMPORTANT] Before submitting an SVG, ensure you have the right to use it and that its license permits adding it to svgl. If you are uncertain, please contact the author or the company.

You will need:

• Node.js 20+.
• Git.

1. Fork this repository and clone it locally:

git clone git@github.com:your_username/svgl.git

2. Install dependencies:

# Install pnpm globally if you don't have it:
npm install -g pnpm

# and install dependencies:
pnpm install

3. Go to the static/library folder and add your .svg logo.

[!WARNING]

• Remember to optimize SVG for web, you can use SVGOMG.
• When you optimize the SVG, make sure that the viewBox is not removed.
• The size limit for each .svg is 21kb.

4. Go to the src/data/svgs.ts and add the information about your logo, following the structure:

• Simple logo:

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  url: 'Website'
}

• Simple logo + wordmark:

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  wordmark: '/library/your_logo_wordmark.svg',
  url: 'Website'
}

• Logo (light & dark mode):

{
  title: 'Title',
  category: 'Category',
  route: {
    light: '/library/your_logo_light.svg',
    dark: '/library/your_logo_dark.svg'
  },
  url: 'Website'
}

• Wordmark (light & dark mode):

{
  title: 'Title',
  category: 'Category',
  wordmark: {
    light: '/library/your_logo_light.svg',
    dark: '/library/your_logo_dark.svg'
  },
  url: 'Website'
}

• Full example with all properties:

{
  title: 'Title',
  category: 'Category',
  route: {
    light: '/library/your_logo_light.svg',
    dark: '/library/your_logo_dark.svg'
  },
  wordmark: {
    light: '/library/your_logo_wordmark_light.svg',
    dark: '/library/your_logo_wordmark_dark.svg'
  },
  url: 'Website'
}

• Add brand guidelines (where to find the images, how to use it, colors, fonts...):

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  wordmark: '/library/your_logo_wordmark.svg',
  brandUrl: 'https://assets.website.com/brand-guidelines',
  url: 'Website'
}

• Add Loftlyy brand URL:

Loftlyy is a brand identity reference site — discover and explore brand colors, typography, logos, and design systems. Created by preetsuthar17.

{
  title: 'Title',
  category: 'Category',
  route: '/library/your_logo.svg',
  wordmark: '/library/your_logo_wordmark.svg',
  loftlyyUrl: 'https://www.loftlyy.com/en/brand-name',
  url: 'Website'
}

[!NOTE]

• The list of categories is here: src/types/categories.ts. You can add a new category if you need it.
• You can add multiple categories to the same logo, for example: category: ['Social', 'Design'].

And create a pull request with your logo ✨.

🧑‍🚀 Getting Started with API

[!WARNING] This section is how to run API locally. For all API endpoints, check the API documentation.

1. Install the dependencies (optional if you run the web app previously):

pnpm install

2. Go to the api-routes folder and generate SVGs data using generate-data.mjs script:

cd api-routes
pnpm build:data

3. Create a .env file inside the api-routes folder and add the following environment variables:

CORS_ORIGIN= # use your local development URL, e.g., http://localhost:5173
REDIS_URL= # use your Redis URL, e.g., rediss://:password@hostname:port

You can create a Redis server using: Railway - Coolify - Koyeb - Local with Docker.

4. Run the API server:

pnpm dev

Ready 🚀

✌️ Contributing

🔑 License

• MIT.