https://github.com/ismarslomic/mmm-hello-world-ts
Hello world custom module for Magic Mirror written in TypeScript
https://github.com/ismarslomic/mmm-hello-world-ts
magicmirror2
Last synced: 8 months ago
JSON representation
Hello world custom module for Magic Mirror written in TypeScript
- Host: GitHub
- URL: https://github.com/ismarslomic/mmm-hello-world-ts
- Owner: ismarslomic
- License: mit
- Created: 2023-02-25T17:27:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T07:32:46.000Z (over 1 year ago)
- Last Synced: 2025-02-10T08:27:49.536Z (over 1 year ago)
- Topics: magicmirror2
- Language: JavaScript
- Homepage:
- Size: 1.97 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Magic Mirror module: Hello world
[](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/codeql.yml)
[](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/eslint.yml)
[](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/build.yml)
[](https://github.com/ismarslomic/MMM-Hello-World-Ts/actions/workflows/e2e-tests.yml)
[](https://codecov.io/gh/ismarslomic/MMM-Hello-World-Ts)
> Simple Magic Mirror module written in Typescript demonstrating use of
> the [core module file ](https://docs.magicmirror.builders/development/core-module-file.html#available-module-instance-properties) (
> frontend)
> and [node helper](https://docs.magicmirror.builders/development/node-helper.html) (backend) in addition to using
> the [nunjucks](https://mozilla.github.io/nunjucks/) templates for rendering data.
>
> The transpiled JavaScript files should work in the same way as the original JavaScript
> module [MMM-Hello-World](https://github.com/ismarslomic/MMM-Hello-World).
## Example screenshot
## Installing the module
1. Navigate to the `MagicMirror/modules` directory and execute the following command
```sh
git clone https://github.com/ismarslomic/MMM-Hello-World-Ts.git
```
2. Change into the `MMM-Hello-World-Ts` module folder and install runtime dependencies with
```sh
cd MMM-Hello-World-Ts
npm run install:dep
```
## Using the module
To use this module, add the following configuration block to the modules array in
the `config/config.js` file:
```js
var config = {
modules: [
{
module: 'MMM-Hello-World-Ts',
position: 'top_left',
config: {
text: 'Hello world Ismar!',
},
},
],
}
```
## Development
1. Clone the repository
2. Install the dependencies with `npm install`
3. Automatically recompile the _TypeScript_ files when they are changed with `npm run dev:watch` or run
explicitly with `npm run build`
Note! `pre-commit` hook is configured to run _eslint_, _prettier_ and _build_ before committing the changes to git,
see [lint-staged](lint-staged.config.mjs) and [husky pre-commit](.husky/pre-commit) configuration files.
### Linting and formatting
```bash
npm run lint
npm run prettier
```
### Run unit tests locally
```bash
npm run test:unit
```
### Run e2e tests locally
Make sure Magic Mirror server is running on http://localhost:8080 with config enabling this module before running the E2E tests!
```bash
npm run test:e2e
```
### Codecov integration in Github actions
Add **Repository secret** in your Github repository with name `CODECOV_TOKEN` and a
secret value from your [codecov.io](https://app.codecov.io/gh) account.