Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doroudi/yummyadmin
📈 Vue 3 Dashboard template based on NaiveUI
https://github.com/doroudi/yummyadmin
admin admin-dashboard admin-panel dashboard naive-ui naiveui pinia template vue3 vuejs
Last synced: 29 days ago
JSON representation
📈 Vue 3 Dashboard template based on NaiveUI
- Host: GitHub
- URL: https://github.com/doroudi/yummyadmin
- Owner: doroudi
- License: mit
- Created: 2023-08-28T07:12:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-29T20:04:44.000Z (about 1 month ago)
- Last Synced: 2024-11-29T21:19:40.174Z (about 1 month ago)
- Topics: admin, admin-dashboard, admin-panel, dashboard, naive-ui, naiveui, pinia, template, vue3, vuejs
- Language: Vue
- Homepage: https://yummy-admin.netlify.app
- Size: 1.82 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# YummyAdmin
[](https://github.com/doroudi/YummyAdmin/actions/workflows/ci.yml)
[](https://app.netlify.com/sites/yummy-admin/deploys)
Vue 3 and Naive UI-based Admin Panel. almost complete, with supporting RTL, beautiful design, free, ready to use, and expandable for any other use cases
> **Note**: 🚧 This Project is under active construction and not 100 percent ready.
> **Note**: This project build using [ViteSSE](https://github.com/antfu/vitesse/) template and uses [NaiveUI](https://github.com/tusen-ai/naive-ui) as Component Library.
## Features
- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/), [esbuild](https://github.com/evanw/esbuild) - born with fastness
- 🛒 eCommerce ready sections (products, category, orders, customers)
- 🔐
- 🗂 [File based routing](./src/pages)
- 📦 [Components auto importing](./src/components)
- 🍍 [State Management via Pinia](https://pinia.vuejs.org/)
- 📑 [Layout system](./src/layouts)
- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa)
- 🎨 [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine
- 🌍 [I18n ready](./locales)
- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest), E2E Testing with [Cypress](https://cypress.io/) on [GitHub Actions](https://github.com/features/actions)
- ☁️ Deploy on Netlify, zero-config
## Try it now!
> YummyAdmin requires Node >=18.18
### Clone to local
```bash
npx degit https://github.com/doroudi/yummyadmin my-yummy-admin
cd my-yummy-admin
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change the author name in `LICENSE`
- [ ] Change the title in `locales/en.yaml`
- [ ] Change the hostname in `vite.config.ts`
- [ ] Change the favicon in `public`
- [ ] Remove the `.github` folder which contains the funding info
- [ ] Clean up the READMEs and remove routes
And, enjoy :)
### Development
Just run and visit http://localhost:7000
```bash
pnpm dev:mock
```
### Build
To build the App, run
```bash
pnpm build
```
And you will see the generated file in `dist` that ready to be served.
### Deploy on Netlify
Go to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.
### Docker Production Build
First, build the vitesse image by opening the terminal in the project's root directory.
```bash
docker buildx build . -t yummyadmin:latest
```
Run the image and specify port mapping with the `-p` flag.
```bash
docker run --rm -it -p 8080:80 yummyadmin:latest
```