{"id":21094415,"url":"https://github.com/domicoder/kitboxhealth-webapp","last_synced_at":"2025-03-14T07:09:55.936Z","repository":{"id":253025820,"uuid":"842234487","full_name":"domicoder/kitboxhealth-webapp","owner":"domicoder","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-15T06:41:07.000Z","size":2464,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T01:41:49.661Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/domicoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-14T00:10:51.000Z","updated_at":"2024-08-15T06:41:11.000Z","dependencies_parsed_at":"2024-08-14T02:31:18.209Z","dependency_job_id":"4055be79-22d2-4be5-a6de-07e8b66915b8","html_url":"https://github.com/domicoder/kitboxhealth-webapp","commit_stats":null,"previous_names":["domicoder/kitboxhealth-webapp"],"tags_count":0,"template":false,"template_full_name":"domicoder/vuetres","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domicoder%2Fkitboxhealth-webapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domicoder%2Fkitboxhealth-webapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domicoder%2Fkitboxhealth-webapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/domicoder%2Fkitboxhealth-webapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/domicoder","download_url":"https://codeload.github.com/domicoder/kitboxhealth-webapp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243538137,"owners_count":20307104,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T22:17:27.567Z","updated_at":"2025-03-14T07:09:55.908Z","avatar_url":"https://github.com/domicoder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💚 KitboxHealth\n\nThis template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses the [new `\u003cscript setup\u003e` syntax](https://github.com/vuejs/rfcs/pull/227). Check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.\n\n## 🧩 Features\n\n- Core:\n\n  - ⚡️ Vue 3: [vue-3](https://github.com/vuejs/vue-next)\n  - 🦾 Typescript: [typescript](https://github.com/microsoft/TypeScript)\n  - ⚡️ Vite: [vite](https://github.com/vitejs/vite)\n  - 🗺️ Vue Router: [vue-router](https://github.com/vuejs/vue-router)\n  - 🌍 Vue-i18n: [vue-i18n](https://github.com/intlify/vue-i18n-next)\n  - 🔤 Webfont self-hosting: [vite-plugin-webfont-dl](https://github.com/feat-agency/vite-plugin-webfont-dl)\n\n- State Management:\n  - 🍍 Pinia: [pinia](https://github.com/vuejs/pinia)\n- UI Framework:\n  - 🦄 Tailwind CSS: [tailwindcss](https://github.com/tailwindlabs/tailwindcss)\n- API Client:\n  - 📡 Axios: [axios](https://github.com/axios/axios)\n- Pre commit hooks and Linters and Formatters:\n  - 💬 Husky: [husky](https://github.com/typicode/husky)\n  - 💬 Lint-staged: [lint-staged](https://github.com/okonet/lint-staged)\n  - 💅 ESLint: [eslint](https://github.com/eslint/eslint)\n  - 💅 Prettier: [prettier](https://github.com/prettier/prettier)\n- Opinionated Testing:\n  - 🎭 Playwright: [playwright](https://github.com/microsoft/playwright)\n  - 🧪 Vitest: [vitest](https://github.com/vitest-dev/vitest)\n\n## 🧰 Recommended Setup\n\n- [VS Code](https://code.visualstudio.com/)\n\n  - [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously Volar) and `disable Vetur.`\n\n  - Use [vue-tsc](https://github.com/vuejs/language-tools/tree/master/packages/tsc) for performing the same type checking from the command line, or for generating d.ts files for SFCs.\n  - [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)\n  - [ESLint for VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n  - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n\n## 📦 🧰 Additional Setup\n\n- VSCode Extension [Better Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)\n- VSCode Extension [Color Highlight](https://marketplace.visualstudio.com/items?itemName=naumovs.color-highlight)\n- VSCode Extension [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)\n- VSCode Extension [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)\n- VSCode Extension [Git History](https://marketplace.visualstudio.com/items?itemName=donjayamanne.githistory)\n- VSCode Extension [Git Graph](https://marketplace.visualstudio.com/items?itemName=GitGraph.vscode-gitgraph)\n- VSCode Extension [Git Blame](https://marketplace.visualstudio.com/items?itemName=waderyan.gitblame)\n\n## ⚙️ Environment Setup\n\n- `Node:` v20.11.0 (LTS/iron May 2024)\n- `NPM:` v10.5.2\n- `NVM:` v0.38.0\n\n## 💅 Code Styling\n\n- ESLint rules are defined in `.eslintrc.json`\n- Prettier rules are defined in `.prettierrc`.\n- Pre-commit hooks are defined in `.husky/pre-commit`.\n\n## 💅 CSS Architecture\n\nWe use Tailwind CSS for styling. It is a utility-first CSS framework that provides a set of pre-built components and utilities that can be used to quickly build responsive and visually appealing web pages.\n\n## ⚗️ Husky pre-commit hooks\n\nHusky is a package that allows you to run a script before every commit. It can be used to check code formatting, run tests, or perform other tasks.\nWe use 3 pre-commit hooks:\n\n- `pre-commit`: Runs ESLint on the staged files.\n- `commit-msg`: Runs commitlint on the commit message.\n- `pre-push`: Runs unit tests on the staged files.\n\n\u003c!-- ## 🏗 Project Structure --\u003e\n\n## 🛠 NPM scripts for Development\n\n### 🪄 Init\n\n```bash\n# install nvm if you don't have it\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash\n```\n\n```bash\nnvm use # If you have nvm installed with node version 20.11.0\nnvm install # Install node version 20.11.0 using nvm\n```\n\n### 📦 Installation\n\n```bash\nnpm install # Install all dependencies\n```\n\n### 🔨 Compile and hot-reload for development\n\n```bash\nnpm run dev # Compile and hot-reload for development\n```\n\n### 📝 Lint and fix files\n\n```bash\nnpm run lint # run lint\nnpm run lint:fix # run lint --fix\n```\n\n### 🚀 Build\n\n```bash\nnpm run build # Build the project for production\n```\n\n### 👁 Preview\n\n```bash\nnpm run preview # Preview of the locally packaged project\n```\n\n### 🔬 Test Setup\n\n```bash\nnpm run test-setup # Install playwright\n```\n\n### 🧪 Run unit tests\n\n```bash\nnpx playwright test # Run playwright\nnpx playwright show-report # Show playwright report\nnpx playwright test --ui # Run playwright with UI\n\n# or\nnpm run test:unit\nnpm run test:e2e\nnpm run test # Runs both unit and e2e tests\n```\n\n## Commit Message Conventions\n\nWe use [commitlint](https://github.com/conventional-changelog/commitlint) to enforce a conventional commit message format. This ensures that the commit message follows a standard format that is easy to read and understand.\n\nThe commitlint configuration file is located at `.commitlintrc.json`. It specifies the rules for validating commit messages.\n\n```bash\n\u003ctype\u003e(\u003cscope\u003e): \u003csubject\u003e\n```\n\n#### `\u003ctype\u003e`\n\n- Descibes the category of your change.\n- Commonly used: `build`, `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, etc.\n\n#### `\u003cscope\u003e`\n\n- Optional argument.\n- Describes the module affected by your change.\n- Highly project specific.\n- Commonly used: `core`, `ui`, `api`, `state`, `utils`, `types`, `config`, `tests`, etc.\n\n#### `\u003csubject\u003e`\n\n- Terse description.\n- Avoid repeating information from type and scope.\n- Describe what the software does after your change.\n\n#### Help\n\n```bash\n'init:     initial commit'\n'feat:     add new feature'\n'fix:      fix bug'\n'ui:       update UI'\n'refactor: refactor code'\n'perf:     performance code or flows'\n'release:  release application'\n'deploy:   deploy on server'\n'docs:     change docs'\n'test:     add testing'\n'chore:    change settings (ex. deps)'\n'style:    update style without logic change'\n'revert:   revert commit'\n```\n\n#### Examples\n\n```bash\nfeat(core): add new feature\n\nfix(core): fix bug in component\n\nperf(cache): optimize cache retrieval speed\n\nchore(deps): update dependency versions\n\nrefactor(user): simplify user creation logic\n\ndocs(ui): update documentation\n\ndocs(readme): update installation instructions\n\nchore: update .gitignore\n```\n\n## Browser support\n\nThe `Chrome 80+` browser is recommended for local development\n\nSupport modern browsers, doesn't include IE\n\n| [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\" alt=\" Edge\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eIE | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\" alt=\" Edge\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eEdge | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\" alt=\"Firefox\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eFirefox | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\" alt=\"Chrome\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eChrome | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eSafari |\n| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n|                                                                                             not support                                                                                              |                                                                                            last 2 versions                                                                                             |                                                                                                  last 2 versions                                                                                                  |                                                                                                last 2 versions                                                                                                |                                                                                                last 2 versions                                                                                                |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdomicoder%2Fkitboxhealth-webapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdomicoder%2Fkitboxhealth-webapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdomicoder%2Fkitboxhealth-webapp/lists"}