Merge branch 'develop'

.eslintrc.json

@@ -1,3 +1,3 @@
 {
-  "extends": "next/core-web-vitals"
+  "extends": ["next/core-web-vitals"]
 }

.gitignore

@@ -1,42 +1,42 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
+# dependencies ->
 /node_modules
 /.pnp
 .pnp.js
+package-lock.json
 
-# testing
+# testing ->
 /coverage
 
-# next.js
+# next.js ->
 /.next/
 /out/
 
-# production
+# production ->
 /build
 
-# misc
+# misc ->
 .DS_Store
 *.pem
 
-# debug
+# debug ->
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
+
+# local env files ->
+.env*.local
+
+# vercel ->
+.vercel
 
-# local env files
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+# typescript ->
+*.tsbuildinfo
 
-# PWA files
+# PWA files ->
 **/public/sw.js
 **/public/workbox-*.js
 **/public/worker-*.js
 **/public/sw.js.map
 **/public/workbox-*.js.map
 **/public/worker-*.js.map
-
-# vercel
-.vercel

README.md

@@ -1,27 +1,108 @@
 <p align="center">
-  <a href="https://svgl.vercel.app/">
-    <img src="https://raw.githubusercontent.com/pheralb/svgl/main/public/images/banner.png" width="800px" alt="svgl preview" />
+  <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>
 
-## 🚀 Getting started:
+## 📦 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.
 
-[SVGL](https://svgl.vercel.app/) is a beautiful collection of SVG logos. Free and open source.
+## 🚀 Getting started:
 
 You need:
 
-- [Node.js 16+ (recommend: 16.14.0 LTS)](https://nodejs.org/en/)
+- [Node.js 16+ (recommend: 16.15.1 LTS)](https://nodejs.org/en/)
 - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
 
-and run:
+1. Clone the repository:
+
+```bash
+[email protected]: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 [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [localhost:3000](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](https://github.com/pheralb/svgl/fork).
+
+2. Clone the forked repository:
+
+```bash
+[email protected]:YOUR_USERNAME/svgl.git
+```
+
+3. Add the **.svg** logo here: [`/public/library`](https://github.com/pheralb/svgl/tree/main/public/library).
+
+4. Add your logo information here following the structure: [`/data/svgs.json`](https://github.com/pheralb/svgl/tree/main/public/library).
+
+```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:
+
+```bash
+git add .
+git commit -m "🥰 Added my logo"
+git push origin main
+```
+
+6. Create a pull request with your changes and 🥳 ready.
+
+## 🚂 Api endpoints:
+
+```bash
+- /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/](https://github.com/pheralb/svgl/tree/main/public/library).
+- ✍️ SVG JSON logos: [/data/](https://github.com/pheralb/svgl/tree/main/data).
 
 ## 🔑 License:
 
-MIT
+- [MIT](https://github.com/pheralb/svgl/blob/main/LICENSE).