svgl/README.md

73 lines
1.8 KiB
Markdown
Raw Normal View History

2022-03-04 21:34:58 +08:00
<p align="center">
<a href="https://svgl.vercel.app/">
2022-06-21 19:52:47 +08:00
<img src="https://i.postimg.cc/7LZ1tVf6/banner.png" width="800px" alt="SVGL Banner" />
2022-03-04 21:34:58 +08:00
</a>
</p>
2022-06-20 22:27:28 +08:00
## 📦 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.
2022-06-20 22:27:28 +08:00
- 💅 [Chakra UI](https://chakra-ui.com/) - Create accessible React apps with speed.
- 💥 [Framer Motion](https://www.framer.com/motion/) - Production-ready motion library.
2022-06-21 00:26:46 +08:00
- 💖 [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.
2022-01-16 22:40:15 +08:00
2022-06-20 22:27:28 +08:00
## 🚀 Getting started:
2022-03-04 21:34:58 +08:00
2022-01-17 06:27:55 +08:00
You need:
2022-06-20 22:27:28 +08:00
- [Node.js 16+ (recommend: 16.15.1 LTS)](https://nodejs.org/en/)
2022-01-17 06:27:55 +08:00
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
2022-06-20 22:27:28 +08:00
1. Clone the repository:
```bash
git@github.com:pheralb/svgl.git
```
2. Install dependencies:
2022-01-16 22:40:15 +08:00
```bash
2022-01-17 06:27:55 +08:00
npm install
2022-06-20 22:27:28 +08:00
# or
yarn install
```
3. Run:
```bash
npm run dev
2022-06-20 22:27:28 +08:00
# or
yarn dev
```
4. Test & Build:
```bash
npm run ready
# or
yarn ready
```
2022-01-16 22:40:15 +08:00
2022-06-20 22:27:28 +08:00
🥳 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.
```
2022-06-20 22:27:28 +08:00
## ⚒️ 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).
2022-01-16 22:40:15 +08:00
2022-03-04 21:34:58 +08:00
## 🔑 License:
2022-01-16 22:40:15 +08:00
2022-06-20 22:27:28 +08:00
- [MIT](https://github.com/pheralb/svgl/blob/main/LICENSE).