svgl/README.md

📦 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:

• Node.js 16+ (recommend: 16.15.1 LTS)
• Git

1. Clone the repository:

git@github.com:pheralb/svgl.git

2. Install dependencies:

npm install
# or
yarn install

3. Run:

npm run dev
# or
yarn dev

4. 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:

git@github.com:YOUR_USERNAME/svgl.git

3. Add the .svg logo here: /public/library.

4. 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"
}

5. Create a commit and push:

git add .
git commit -m "🥰 Added my logo"
git push origin main

6. 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:

• ⭐ SVG Library: /public/library/.
• ✍️ SVG JSON logos: /data/.

🔑 License:

• MIT.