{"id":16479699,"url":"https://github.com/ismarslomic/mmm-hello-world-ts","last_synced_at":"2025-10-27T16:31:50.175Z","repository":{"id":148099749,"uuid":"606502459","full_name":"ismarslomic/MMM-Hello-World-Ts","owner":"ismarslomic","description":"Hello world custom module for Magic Mirror written in TypeScript","archived":false,"fork":false,"pushed_at":"2025-02-10T07:32:46.000Z","size":2068,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-10T08:27:49.536Z","etag":null,"topics":["magicmirror2"],"latest_commit_sha":null,"homepage":"","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/ismarslomic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-25T17:27:15.000Z","updated_at":"2025-02-10T07:32:49.000Z","dependencies_parsed_at":"2023-05-19T04:00:32.131Z","dependency_job_id":"16a29dbc-1c83-4eac-b71b-198265336bfb","html_url":"https://github.com/ismarslomic/MMM-Hello-World-Ts","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismarslomic%2FMMM-Hello-World-Ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismarslomic%2FMMM-Hello-World-Ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismarslomic%2FMMM-Hello-World-Ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismarslomic%2FMMM-Hello-World-Ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ismarslomic","download_url":"https://codeload.github.com/ismarslomic/MMM-Hello-World-Ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238526975,"owners_count":19487138,"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":["magicmirror2"],"created_at":"2024-10-11T12:52:41.260Z","updated_at":"2025-10-27T16:31:44.817Z","avatar_url":"https://github.com/ismarslomic.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Magic Mirror module: Hello world\n\n[![CodeQL](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/codeql.yml/badge.svg)](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/codeql.yml)\n[![ESLint](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/eslint.yml/badge.svg)](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/eslint.yml)\n[![ESLint](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/build.yml/badge.svg)](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/build.yml)\n[![E2E tests](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/e2e-tests.yml)\n[![Unit tests](https://codecov.io/gh/ismarslomic/MMM-Hello-World-Ts/branch/main/graph/badge.svg?token=MQPHY294KB)](https://codecov.io/gh/ismarslomic/MMM-Hello-World-Ts)\n\n\u003e Simple Magic Mirror module written in Typescript demonstrating use of\n\u003e the [core module file ](https://docs.magicmirror.builders/development/core-module-file.html#available-module-instance-properties) (\n\u003e frontend)\n\u003e and [node helper](https://docs.magicmirror.builders/development/node-helper.html) (backend) in addition to using\n\u003e the [nunjucks](https://mozilla.github.io/nunjucks/) templates for rendering data.\n\u003e\n\u003e The transpiled JavaScript files should work in the same way as the original JavaScript\n\u003e module [MMM-Hello-World](https://github.com/ismarslomic/MMM-Hello-World).\n\n## Example screenshot\n\n![Screenshot](screenshot.png)\n\n## Installing the module\n\n1. Navigate to the `MagicMirror/modules` directory and execute the following command\n\n   ```sh\n   git clone https://github.com/ismarslomic/MMM-Hello-World-Ts.git\n   ```\n\n2. Change into the `MMM-Hello-World-Ts` module folder and install runtime dependencies with\n   ```sh\n   cd MMM-Hello-World-Ts\n   npm run install:dep\n   ```\n\n## Using the module\n\nTo use this module, add the following configuration block to the modules array in\nthe `config/config.js` file:\n\n```js\nvar config = {\n  modules: [\n    {\n      module: 'MMM-Hello-World-Ts',\n      position: 'top_left',\n      config: {\n        text: 'Hello world Ismar!',\n      },\n    },\n  ],\n}\n```\n\n## Development\n\n1. Clone the repository\n2. Install the dependencies with `npm install`\n3. Automatically recompile the _TypeScript_ files when they are changed with `npm run dev:watch` or run\n   explicitly with `npm run build`\n\nNote! `pre-commit` hook is configured to run _eslint_, _prettier_ and _build_ before committing the changes to git,\nsee [lint-staged](lint-staged.config.mjs) and [husky pre-commit](.husky/pre-commit) configuration files.\n\n### Linting and formatting\n\n```bash\nnpm run lint\nnpm run prettier\n```\n\n### Run unit tests locally\n\n```bash\nnpm run test:unit\n```\n\n### Run e2e tests locally\n\nMake sure Magic Mirror server is running on http://localhost:8080 with config enabling this module before running the E2E tests!\n\n```bash\nnpm run test:e2e\n```\n\n### Codecov integration in Github actions\n\nAdd **Repository secret** in your Github repository with name `CODECOV_TOKEN` and a\nsecret value from your [codecov.io](https://app.codecov.io/gh) account.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fismarslomic%2Fmmm-hello-world-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fismarslomic%2Fmmm-hello-world-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fismarslomic%2Fmmm-hello-world-ts/lists"}