svgl/README.md

<p align="center">
  <a href="https://svgl.vercel.app/" target="_blank">
    <img src="https://i.postimg.cc/1tzrP2rg/banner-corner.png" width="800px" alt="SVGL Banner" />
  </a>
</p>

## 📦 Packages:

- ⚡️ [Nextjs](https://nextjs.org/) - The React Framework for Production.
- ⚒️ [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces.
- 💙 [Typescript](https://www.typescriptlang.org/) - A superset of JavaScript.
- ✅ [Vitest](https://vitest.dev/) - A blazing fast unit test framework.
- 💅 [Chakra UI](https://chakra-ui.com/) - Create accessible React apps with speed.
- 💥 [Framer Motion](https://www.framer.com/motion/) - Production-ready motion library.
- 💖 [Phosphor Icons](https://phosphoricons.com/) - A flexible icon family for everyone.
- ⬇️ [Next-PWA](https://github.com/shadowwalker/next-pwa) - Zero config PWA plugin for Next.js, with workbox.

## 🚀 Getting started:

You need:

- [Node.js 16+ (recommend: 16.15.1 LTS)](https://nodejs.org/en/)
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

1. Clone the repository:

```bash
git@github.com:pheralb/svgl.git
```

2. Install dependencies:

```bash
npm install
# or
yarn install
```

3. Run:

```bash
npm run dev
# or
yarn dev
``` 

4. Test & Build:

```bash
npm run ready
# or
yarn ready
``` 

🥳 Open [localhost:3000](localhost:3000) with your browser to see the result.

## 🚂 Endpoints:

```bash
- /api/all: returns all the logos in the /data/ folder.
- /api/search?id=2: returns the logo with id 2.
- /api/search?name=logo: returns the logo with name logo.
```

## ⚒️ Shortcuts:

- ⭐ SVG Library: [/public/library/](https://github.com/pheralb/svgl/tree/main/public/library).
- ✍️ SVG JSON logos: [/data/](https://github.com/pheralb/svgl/tree/main/data).

## 🔑 License:

- [MIT](https://github.com/pheralb/svgl/blob/main/LICENSE).