mirror of
https://github.com/pheralb/svgl.git
synced 2025-02-06 06:58:04 +08:00
⚒️ Fix readme - add vitest & endpoints.
This commit is contained in:
parent
dfdbb66a73
commit
177ed3a1e5
19
README.md
19
README.md
@ -9,6 +9,7 @@
|
|||||||
- ⚡️ [Nextjs](https://nextjs.org/) - The React Framework for Production.
|
- ⚡️ [Nextjs](https://nextjs.org/) - The React Framework for Production.
|
||||||
- ⚒️ [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces.
|
- ⚒️ [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces.
|
||||||
- 💙 [Typescript](https://www.typescriptlang.org/) - A superset of JavaScript.
|
- 💙 [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.
|
- 💅 [Chakra UI](https://chakra-ui.com/) - Create accessible React apps with speed.
|
||||||
- 💥 [Framer Motion](https://www.framer.com/motion/) - Production-ready motion library.
|
- 💥 [Framer Motion](https://www.framer.com/motion/) - Production-ready motion library.
|
||||||
- 💖 [Phosphor-Icons](https://phosphoricons.com/) - A flexible icon family for everyone.
|
- 💖 [Phosphor-Icons](https://phosphoricons.com/) - A flexible icon family for everyone.
|
||||||
@ -41,10 +42,26 @@ yarn install
|
|||||||
npm run dev
|
npm run dev
|
||||||
# or
|
# or
|
||||||
yarn dev
|
yarn dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
4. Test & Build:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run ready
|
||||||
|
# or
|
||||||
|
yarn ready
|
||||||
|
```
|
||||||
|
|
||||||
🥳 Open [localhost:3000](localhost:3000) with your browser to see the result.
|
🥳 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:
|
## ⚒️ Shortcuts:
|
||||||
|
|
||||||
- ⭐ SVG Library: [/public/library/](https://github.com/pheralb/svgl/tree/main/public/library).
|
- ⭐ SVG Library: [/public/library/](https://github.com/pheralb/svgl/tree/main/public/library).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user