{"id":19228232,"url":"https://github.com/capitec/template-pwa-html","last_synced_at":"2025-02-23T10:40:47.134Z","repository":{"id":173886468,"uuid":"647302463","full_name":"capitec/template-pwa-html","owner":"capitec","description":"PWA starter template for vanilla HTML-based SPA development.","archived":false,"fork":false,"pushed_at":"2023-07-06T12:03:17.000Z","size":169,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-04T22:27:37.255Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/capitec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-05-30T13:42:43.000Z","updated_at":"2023-06-09T07:34:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"bfb5dadc-8e84-4177-a0a7-4abfa6740802","html_url":"https://github.com/capitec/template-pwa-html","commit_stats":null,"previous_names":["capitec/template-pwa-html"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capitec%2Ftemplate-pwa-html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capitec%2Ftemplate-pwa-html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capitec%2Ftemplate-pwa-html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capitec%2Ftemplate-pwa-html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/capitec","download_url":"https://codeload.github.com/capitec/template-pwa-html/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240304573,"owners_count":19780312,"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-09T15:27:15.242Z","updated_at":"2025-02-23T10:40:47.088Z","avatar_url":"https://github.com/capitec.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\n\nProgressive Web App (PWA) starter template for HTML-based Single-page application (SPA) development, leveraging various [Omni](https://github.com/capitec?q=omni-) libraries.\n\n### Headline Features: 🌟\n- Dark-mode support.\n- Testing, linting \u0026 formatting support.\n- Basic SPA boilerplate with routing \u0026 PWA setup.\n\n### Key Dependencies: 🛠️\n- Tooling\n    - [VS Code](https://code.visualstudio.com) for application development.\n    - [Playwright](https://playwright.dev/) for end-to-end headless browser testing.\n    - [ESLint](https://eslint.org/) for static code analysis.\n    - [Prettier](https://prettier.io/) for opinionated code formatting.\n- Runtime\n    - [Omni Components](https://github.com/capitec/omni-components) for UI components.\n    - [Omni Router](https://github.com/capitec/omni-router) for client-side routing.\n\n# Usage\n\n1️⃣ \u0026nbsp; Create a new [repository from this template](https://github.com/capitec/template-pwa-html/generate) (or fork) and clone locally:\n\n```bash\ngit clone https://github.com/{your-repo-name}.git\ncd {your-repo-name}\n```\n\n2️⃣ \u0026nbsp; Restore all package dependencies:\n\n```bash\nnpm i\n```\n\n3️⃣ \u0026nbsp; Open it in VS Code:\n\n```bash\ncode .\n```\n\n# Scripts\nThe following NPM scripts within `package.json` should be noted:\n\n- `serve` - Launches a simple web server, serving the `src` directory.\n- `test` - Launches the [Playwright](#run-end-to-end-tests-with-playwright) test runner \u0026 executes all tests within `tests` directory.\n- `format` - Runs the Prettier formatter on all `.js` files, applying format updates where necessary.\n- `lint`- Runs the ESLint analyzer on all `.js` files, applying code updates where necessary.\n\n# Run End-to-End Tests with [Playwright](https://playwright.dev)\n\n```sh\n# Install browsers for the first run (Required)\nnpx playwright install\n\n# Runs the end-to-end tests\nnpm run test\n\n# Runs the tests only on Chromium\nnpm run test -- --project=chromium\n\n# Runs the tests of a specific file\nnpm run test -- tests/example.spec.ts\n\n# Runs the tests in debug mode\nnpm run test -- --debug\n```\n\n# Showcased Features\n|     Feature    |  Availability | Description |\n|-------------------------------|-----|-------------------------------------------------------------------------|\n|    Components                 | ✅  | [Omni Components](https://github.com/capitec/omni-components)           |\n|    Routing                    | ✅  | [Omni Router](https://github.com/capitec/omni-router)                   |\n|    Tests                      | ✅  | Provided via [Playwright](https://playwright.dev/)                      |\n|    Serve                      | ✅  | Provided via [http-server](https://www.npmjs.com/package/http-server)   |\n|    Formatting                 | ✅  | Provided via [Prettier](https://prettier.io/)                           |\n|    Linting                    | ✅  | Provided via [ESLint](https://eslint.org/)                              |\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapitec%2Ftemplate-pwa-html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapitec%2Ftemplate-pwa-html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapitec%2Ftemplate-pwa-html/lists"}