https://github.com/lumieducation/h5p-nodejs-library
h5p-nodejs-library is a collection of server and client-side packages that help you use H5P with a NodeJS backend
https://github.com/lumieducation/h5p-nodejs-library
h5p nodejs
Last synced: 5 months ago
JSON representation
h5p-nodejs-library is a collection of server and client-side packages that help you use H5P with a NodeJS backend
- Host: GitHub
- URL: https://github.com/lumieducation/h5p-nodejs-library
- Owner: Lumieducation
- License: gpl-3.0
- Created: 2019-05-10T11:58:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-09T10:51:19.000Z (about 1 year ago)
- Last Synced: 2025-05-09T11:55:19.303Z (about 1 year ago)
- Topics: h5p, nodejs
- Language: TypeScript
- Homepage: https://lumieducation.github.io/H5P-Nodejs-library/
- Size: 119 MB
- Stars: 174
- Watchers: 8
- Forks: 86
- Open Issues: 53
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Security: SECURITY.md
Awesome Lists containing this project
README
---
title: Overview
group: Documents
category: Guides
---
# H5P-Nodejs-library
[](https://circleci.com/gh/Lumieducation/H5P-Nodejs-library/tree/master) [](https://coveralls.io/github/Lumieducation/H5P-Nodejs-library?branch=release)
This library provides everything needed to create custom H5P servers running on
NodeJS. It is written in TypeScript and fully typed, which makes it much easier
to work with than the official PHP server. Of course, it's also possible to use
this library in projects with JavaScript (ES5) and you will still profit from
the typings by getting code completion in your IDE.
Even though the repository includes a sample demo project that demonstrates its
functionality, it's still your job to integrate this library into your own
NodeJS server. This is called an "implementation" or "plugin" in H5P
terminology. The implementation is responsible for exposing HTTP endpoints,
persisting data and calling maintenance functions. **This library is not an
out-of-the-box solution to get a standalone H5P server.**
Please note that even if most functionality of H5P works fine and the library is
used by several high-volume projects, there are still some things that could be
added or improved. Check out the [status page of the project](./development/status.md)
for details.
## Packages
The main Git repository is a monorepo that contains several packages, which can
be installed through NPM. The packages are meant to be combined.
| Package name | Functionality | used in |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -------- |
| {@link "@lumieducation/h5p-server"} | the core package to run H5P in NodeJS | backend |
| {@link "@lumieducation/h5p-express"} | routes and controllers for Express | backend |
| {@link "@lumieducation/h5p-webcomponents"} | native web components to display the H5P player and editor in the browser | frontend |
| {@link "@lumieducation/h5p-react"} | React components with the same functionality as the native web components | frontend |
| {@link "@lumieducation/h5p-mongos3"} | storage classes for MongoDB and S3 | backend |
| {@link "@lumieducation/h5p-redis-lock"} | storage class for locks with Redis | backend |
| {@link "@lumieducation/h5p-html-exporter"} | an optional component that can create bundled HTML files for exporting | backend |
| {@link "@lumieducation/h5p-svg-sanitizer"} | an optional package that protects against XSS attack in SVGs if you want to enable SVG in content files | backend |
| {@link "@lumieducation/h5p-clamav-scanner"} | an optional package that checks file uploads for viruses | backend |
## Examples
There are two example implementations that illustrate how the packages can be
used:
| Example type | Tech stack | Location |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| server-side-rendering | server: Express with JS template rendering client: static HTML, some React for library management | `../packages/h5p-examples` |
| [Single Page Application](./examples/rest/README.md) | server: Express with REST endpoints client: React | `../packages/h5p-rest-example-server` `../packages/h5p-rest-example-client` |
## Trying out the demo
Make sure you have [`git`](https://git-scm.com/), [`node ≥ 10.16`](https://nodejs.org/)
, and [`npm`](https://www.npmjs.com/get-npm) installed. If you use
Windows, you must use bash (comes with Git for windows) as a command shell
(otherwise scripts won't run).
1. Clone the repository with git
2. `npm install`
3. `npm start`
You can then open the URL [http://localhost:8080](http://localhost:8080) in any
browser.
## Contributing
Lumi tries to improve education wherever it is possible by providing a software
that connects teachers with their students. Every help is appreciated and
welcome. Feel free to create pull requests. Check out the [documentation pages for developers](./development/getting-started.md) to get started.
This project has adopted the code of conduct defined by the Contributor
Covenant. It can be read in full [here](../code-of-conduct.md).
## Get in touch
[Slack](https://join.slack.com/t/lumi-education/shared_invite/zt-3dcc4gpy-8XxjefFeUHEv89hCMkwmbw)
or [c@Lumi.education](mailto:c@lumi.education).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/Lumieducation/Lumi/tags).
## License
This project is licensed under the GNU GENERAL PUBLIC LICENSE v3 License - see
the [LICENSE](../LICENSE) file for details
## Support
This work obtained financial support for development from the German BMBF-sponsored research project "lea.online" (FKN: W-143600).
Read more about them at the following websites:
- lea.online - [https://blogs.uni-bremen.de/leaonline](https://blogs.uni-bremen.de/leaonline)
- University of Bremen - [https://www.uni-bremen.de/en.html](https://www.uni-bremen.de/en.html)
- BMBF - [https://www.bmbf.de/en/index.html](https://www.bmbf.de/en/index.html)