@arbocollab/arbo-web-target 0.0.1 → 0.0.2-alpha.0

package/README.md

@@ -0,0 +1,131 @@
+## Features
+
+- Vue 3.2: [in here](https://vuejs.org/about/releases.html)
+- Vite 3: [in here](https://vitejs.dev/blog/announcing-vite3.html)
+- Vitest (Testing Framework): [in here](https://vitest.dev/guide/)
+- Composition API: [in here](https://vuejs.org/guide/extras/composition-api-faq.html)
+- Script Setup: [in here](https://vuejs.org/api/sfc-script-setup.html)
+- Routing VitePages / ViteLayout:
+
+  - VitePages: [in here](https://github.com/hannoeru/vite-plugin-pages)
+  - ViteLayout: [in here](https://github.com/johncampionjr/vite-plugin-vue-layouts)
+
+- Pina as Store / CachedPiniaStore for effective data caching: [in here](https://pinia.vuejs.org/)
+- Naive UI as A Vue 3 Component Library: [in here](https://www.naiveui.com/en-US/os-theme)
+- FormKit as A Vue form building framework that simplifies form structure,
+  generation, validation, theming, submission, error handling, and more: [in here](https://formkit.com/)
+- Font Awesome is the Internet's icon library and toolkit, used by millions of designers, developers, and content creators: [in here](https://fontawesome.com/)
+- TypeScript 4.5: [in here](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html)
+- TailwindCSS / DaisyUI:
+
+  - TailwindCSS: [in here](https://tailwindcss.com/)
+  - DaisyUI: [in here](https://daisyui.com/)
+
+- SSG Support: [in here](https://github.com/antfu/vite-ssg)
+- Eslint: [in here](https://eslint.org/)
+
+### Modules
+
+- i18n: [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/src/modules/i18n.ts)
+- pinia: [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/src/modules/pinia.ts)
+- naiveui: [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/src/store/theme.ts)
+- formkit: [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/src/modules/formkit.ts)
+- fontawesome: [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/src/modules/fontawesome.ts)
+
+## Project structure
+
+src folder [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/src):
+
+- `apis` call REST APIS
+- `assets` images, icons
+- `components` Vue Component
+- `composables (hooks)` Vue Composition API (similar to mixins in the Options API in Vue2)
+- `constants` Constant Data
+- `directives` Vue Custom Directive
+- `layouts` Router based layout
+- `modules` configuration language, store, theme, icon and other
+- `pages` Router based page
+- `store` Vue Store (similar to Vuex in Vue2)
+- `styles` stylus and css
+- `types` type, inteface, enum
+- `utils` Typescript helper libraries
+
+test folder [in here](https://github.com/arbocollab/arbo-web-client-targets/blob/dev/test):
+
+- `components` Checks that your component mounts, renders, can be interacted with, and behaves as expected. These tests import more code than unit tests, are more complex, and require more time to execute.
+- `unit` Checks that inputs to a given function, class, or composable are producing the expected output or side effects.
+
+## Project setup and usage
+
+Install node:
+
+**Latest node LTS version required (16)** Use node manager like **nvm** to
+install.
+
+Install pnpm: [https://pnpm.io/installation](https://pnpm.io/installation)
+
+Install dependencies:
+
+```
+pnpm install
+```
+
+Run development server:
+
+```
+pnpm serve
+```
+
+Component test runner:
+
+```
+pnpm test:unit
+```
+
+Build and preview built site locally:
+
+```
+pnpm preview
+```
+
+Build:
+
+```
+pnpm build
+```
+
+Lint .ts files with eslint:
+
+```
+pnpm lint
+```
+
+## Git commit specification reference
+
+- `feat` add new functions
+- `fix` Fix issues/bugs
+- `perf` Optimize performance
+- `style` Change the code style without affecting the running result
+- `refactor` Re-factor code
+- `revert` Undo changes
+- `test` Test related, does not involve changes to business code
+- `docs` Documentation and Annotation
+- `chore` Updating dependencies/modifying scaffolding configuration, etc.
+- `workflow` Work flow Improvements
+- `ci` CICD
+- `types` Type definition
+- `wip` In development
+
+### Docker Production Build
+
+First, build the image by opening the terminal in the project's root directory.
+
+```bash
+docker buildx build . -t arbo-target:latest
+```
+
+Run the image and specify port mapping with the `-p` flag.
+
+```bash
+docker run --rm -it -p 8080:80 arbo-target:latest
+```

package/arbo_logo.svg

@@ -0,0 +1,15 @@
+<svg width="96" height="25" viewBox="0 0 96 25" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0)">
+<path d="M30.9531 19.456L36.4956 6.06689H40.574L46.1165 19.456H43.1884L42.0381 16.7364H34.927L33.7767 19.456H30.9531ZM40.9923 14.4351L38.5871 8.57735H38.2734L35.8682 14.4351H40.9923Z" fill="white"/>
+<path d="M48.7326 6.06689H58.3535C60.7587 6.06689 62.3274 7.63593 62.3274 10.1464C62.3274 12.343 60.9679 13.8075 58.7718 14.0167C58.981 14.2259 59.1901 14.4351 59.2947 14.6443L62.3274 19.5606H59.2947L55.8437 14.0167H51.2424V19.5606H48.5234V6.06689H48.7326ZM58.4581 11.6108C59.2947 11.6108 59.8176 11.0878 59.8176 10.251V9.83258C59.8176 8.99576 59.2947 8.47275 58.4581 8.47275H51.4515V11.6108H58.4581Z" fill="white"/>
+<path d="M65.9844 6.06689H74.8733C77.2785 6.06689 78.8471 7.63593 78.8471 10.1464C78.8471 11.1924 78.4288 12.0292 77.5922 12.6569C78.7425 13.1799 79.37 14.2259 79.37 15.4811C79.37 17.887 77.8014 19.456 75.3961 19.456H65.9844V6.06689ZM74.7687 11.6108C75.6053 11.6108 76.1282 11.0878 76.1282 10.251V9.83258C76.1282 8.99576 75.6053 8.47275 74.7687 8.47275H68.5988V11.6108H74.7687ZM68.5988 17.0502H75.2916C76.1282 17.0502 76.651 16.5271 76.651 15.6903V15.2719C76.651 14.4351 76.1282 13.9121 75.2916 13.9121H68.5988V17.0502Z" fill="white"/>
+<path d="M95.9975 12.7613C95.9975 16.7362 93.0693 19.7697 88.9909 19.7697C85.0171 19.7697 81.9844 16.8408 81.9844 12.7613C81.9844 8.6818 84.9125 5.75293 88.9909 5.75293C93.0693 5.75293 95.9975 8.7864 95.9975 12.7613ZM93.1739 12.7613C93.1739 10.2508 91.3961 8.36799 88.9909 8.36799C86.5857 8.36799 84.8079 10.2508 84.8079 12.7613C84.8079 15.2718 86.5857 17.1546 88.9909 17.1546C91.3961 17.2592 93.1739 15.3764 93.1739 12.7613Z" fill="white"/>
+<path d="M13.7333 1.18213L3.46667 25.1821H24L13.7333 1.18213Z" fill="#F7941D"/>
+<path d="M3.46667 25.1821L13.7333 1.18213L24 25.1821H3" stroke="#F7941D"/>
+</g>
+<defs>
+<clipPath id="clip0">
+<rect width="96" height="25" fill="white"/>
+</clipPath>
+</defs>
+</svg>