Skip to content
forked from pheralb/svgl

πŸš€ A beautiful library with SVG logos.

License

Notifications You must be signed in to change notification settings

JordiNodeJS/svgl

Β 
Β 

Repository files navigation

SVGL Banner

πŸ“¦ Packages:

  • ⚑️ Nextjs - The React Framework for Production.
  • βš’οΈ React 18 - A JavaScript library for building user interfaces.
  • πŸ’™ Typescript - A superset of JavaScript.
  • βœ… Vitest - A blazing fast unit test framework.
  • πŸ’… Chakra UI - Create accessible React apps with speed.
  • πŸ’₯ Framer Motion - Production-ready motion library.
  • πŸ’– Phosphor Icons - A flexible icon family for everyone.
  • ⬇️ Next-PWA - Zero config PWA plugin for Next.js, with workbox.

πŸš€ Getting started:

You need:

  1. Clone the repository:
[email protected]:pheralb/svgl.git
  1. Install dependencies:
npm install
# or
yarn install
  1. Run:
npm run dev
# or
yarn dev
  1. Test & Build:
npm run ready
# or
yarn ready

Open localhost:3000 with your browser to see the result.

πŸ€” Can I add my logo?

Yes! Here is a guide for you πŸ₯³:

  1. Fork the repository.

  2. Clone the forked repository:

[email protected]:YOUR_USERNAME/svgl.git
  1. Add the .svg logo here: /public/library.

  2. Add your logo information here following the structure: /data/svgs.json.

{
  "id": 1,
  "slug": "/library/your_logo.svg",
  "title": "Logo Title",
  "category": "Logo Category",
  "url": "Your Website / app url"
}
  1. Create a commit and push:
git add .
git commit -m "πŸ₯° Added my logo"
git push origin main
  1. Create a pull request with your changes and πŸ₯³ ready.

πŸš‚ Api endpoints:

- /api/all: returns all the logos.
- /api/search?id=2: returns the logo with id 2.
- /api/search?q=logo: returns the logo with query.

βš’οΈ Shortcuts:

πŸ”‘ License:

About

πŸš€ A beautiful library with SVG logos.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.9%
  • CSS 1.2%
  • JavaScript 0.9%