https://github.com/ndlano/h5p-editor-active-reader-placeholder

H5P editor for ActiveReader Placeholder
https://github.com/ndlano/h5p-editor-active-reader-placeholder

Last synced: about 2 months ago
JSON representation

H5P editor for ActiveReader Placeholder

• Host: GitHub
• URL: https://github.com/ndlano/h5p-editor-active-reader-placeholder
• Owner: NDLANO
• License: mit
• Created: 2024-02-26T12:37:21.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-07-15T10:34:59.000Z (5 months ago)
• Last Synced: 2024-07-15T12:38:29.371Z (5 months ago)
• Language: JavaScript
• Size: 688 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
H5P editor for ActiveReader Placeholder

==========

## Getting started

Clone this repository with git and check out the branch that you are interested

in (or choose the branch first and then download the archive, but learning

how to use git really makes sense).

Also ensure to clone related repositories that hold complementary components if

you want to change those.

- [Main ActiveReader view component](https://github.com/ndlano/h5p-active-reader)

- [View component for a placeholder block](https://github.com/ndlano/h5p-active-reader-placeholder)

Change to the repository directory and run

```bash

npm install

```

to install required modules. Afterwards, you can build the project using

```bash

npm run build

```

or, if you want to let everything be built continuously while you are making

changes to the code, run

```bash

npm run watch

```

Before putting the code in production, you should always run `npm run build`.

The build process will transpile ES6 to earlier versions in order to improve

compatibility to older browsers. If you want to use particular functions that

some browsers don't support, you'll have to add a polyfill.

The build process will also move the source files into one distribution file and

minify the code.

In order to lint your code in order to detect H5P coding style guide viloations,

use:

```bash

npm run lint

```

In order to pack an H5P library, please install the

[H5P CLI tool](https://h5p.org/h5p-cli-guide) instead of zipping everything

manually. That tool will take care of a couple of things automatically that you

will need to know otherwise.

In simple cases, something such as

```bash

h5p pack  my-awesome-library.h5p

```

will suffice.

For more information on how to use those distribution files in H5P, please have

a look at https://youtu.be/xEgBJaRUBGg and the H5P developer guide at

https://h5p.org/library-development.