https://github.com/cihat/boardersteller
create a dashboard easily
https://github.com/cihat/boardersteller
Last synced: about 1 year ago
JSON representation
create a dashboard easily
- Host: GitHub
- URL: https://github.com/cihat/boardersteller
- Owner: cihat
- License: mit
- Created: 2023-11-29T08:51:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T22:55:49.000Z (over 2 years ago)
- Last Synced: 2025-05-14T22:12:21.938Z (about 1 year ago)
- Language: TypeScript
- Size: 173 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BoardErsteller
## 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
- π [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
- π [Use icons from any icon sets with classes](https://github.com/antfu/unocss/tree/main/packages/preset-icons)
- π [I18n ready](./locales)
- π [Component Preview](https://github.com/johnsoncodehk/vite-plugin-vue-component-preview)
- π₯ Use the [new `` syntax](https://github.com/vuejs/rfcs/pull/227)
- π₯ [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly
- π¨ Static-site generation (SSG) via [vite-ssg](https://github.com/antfu/vite-ssg)
- π¦ Critical CSS via [critters](https://github.com/GoogleChromeLabs/critters)
- π€ [Webfont self-hosting](https://github.com/feat-agency/vite-plugin-webfont-dl)
- π¦Ύ TypeScript, of course
- βοΈ 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
<br>
## Pre-packed
### UI Frameworks
- [UnoCSS](https://github.com/antfu/unocss) - The instant on-demand atomic CSS engine.
### Icons
- [Iconify](https://iconify.design) - use icons from any icon sets [πIcΓ΄nes](https://icones.netlify.app/)
- [Pure CSS Icons via UnoCSS](https://github.com/antfu/unocss/tree/main/packages/preset-icons)
### Plugins
- [Vue Router](https://github.com/vuejs/router)
- [`unplugin-vue-router`](https://github.com/posva/unplugin-vue-router) - file system based routing
- [`vite-plugin-vue-layouts`](https://github.com/JohnCampionJr/vite-plugin-vue-layouts) - layouts for pages
- [Pinia](https://pinia.vuejs.org) - Intuitive, type safe, light and flexible Store for Vue using the composition api
- [`unplugin-vue-components`](https://github.com/antfu/unplugin-vue-components) - components auto import
- [`unplugin-auto-import`](https://github.com/antfu/unplugin-auto-import) - Directly use Vue Composition API and others without importing
- [`unplugin-vue-macros`](https://github.com/sxzz/unplugin-vue-macros) - Explore and extend more macros and syntax sugar to Vue.
- [`vite-plugin-pwa`](https://github.com/antfu/vite-plugin-pwa) - PWA
- [Vue I18n](https://github.com/intlify/vue-i18n-next) - Internationalization
- [`unplugin-vue-i18n`](https://github.com/intlify/bundle-tools/tree/main/packages/unplugin-vue-i18n) - unplugin for Vue I18n
- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs
- [`vite-ssg-sitemap`](https://github.com/jbaubree/vite-ssg-sitemap) - Sitemap generator
- [`@vueuse/head`](https://github.com/vueuse/head) - manipulate document head reactively
- [`vite-plugin-webfont-dl`](https://github.com/feat-agency/vite-plugin-webfont-dl) - Zero-config webfont (Google Fonts) downloader and injector to improve website's performance.
- [`vite-plugin-vue-devtools`](https://github.com/webfansplz/vite-plugin-vue-devtools) - Designed to enhance the Vue developer experience.
### Coding Style
- Use Composition API with [`<script setup>` SFC syntax](https://github.com/vuejs/rfcs/pull/227)
- [ESLint](https://eslint.org/) with [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi.
## Checklist
When you use this template, try follow the checklist to update your info properly
- [x] Change the author name in `LICENSE`
- [x] Change the title in `App.vue`
- [ ] 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 :)
## Usage
### Development
Just run and visit http://localhost:3333
```bash
pnpm dev
```
### 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.