Giter VIP home page Giter VIP logo

lumieducation / lumi Goto Github PK

View Code? Open in Web Editor NEW
112.0 11.0 23.0 226.62 MB

Lumi is a Desktop App that offers a collection of tools to create, edit and share digital content with your class.

Home Page: http://Lumi.education

License: GNU Affero General Public License v3.0

JavaScript 60.70% Shell 0.12% TypeScript 24.39% HTML 0.49% CSS 10.75% SCSS 3.52% Batchfile 0.03%
lumi education desktop

lumi's Introduction

Lumi

Lumi is a Desktop App that offers a collection of tools to create, edit and share digital content with your class.

Lumi is currently in a very early development phase and offers only one tool: a H5P Editor. Other tools will be added in later versions.

Download the latest version here.

It’s built with TypeScript – a nodejs plus express and socket.io server, React.js, Redux and Material-ui. It runs as a Electron-Standalone App on Mac OS X, Windows and Linux.

Contributing

Lumi tries to improve education wherever it is possible by providing a software that connects teachers with their students. But Lumi is in a very early development stage. Every help is appreciated and welcome. You can contribute in many ways. You can help reporting, testing, and detailing bugs, and also test and suggest new features. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

We manage the localization of Lumi on translate-h5p.tk in the project Lumi Education. The Weblate installation there makes it easy to add translations into your language. Please read the guide how to contribute and register on translate-h5p.tk if you're interested in helping out!

Lumi has adopted the code of conduct defined by the Contributor Covenant. It can be read in full here.

Get in touch

Contact us at [email protected].

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE v3 License

lumi's People

Contributors

benabel avatar cedric-pdl avatar germanvaleroelizondo avatar jpschellenberg avatar kareemdardir avatar maxtetdev avatar renovate-bot avatar renovate[bot] avatar semantic-release-bot avatar sr258 avatar translate-h5p avatar vormia avatar weblate avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

lumi's Issues

'About Lumi' menu items doesn't work in Windows

Describe the bug
The 'About Lumi' menu item doesn't open the about dialog in Windows. The reason is that the 'about' role is only supported in MacOS.

We have to manually create a new windows with the dialog.

Environment (please complete the following information):

  • OS: Win 10

Closing tabs can take a very long time

Describe the bug
For some unknown reason closing tabs can take a very long time, if other tabs have been opened as well.

Environment (please complete the following information):
v0.0.7

Warning when closing tabs with edited content

Currently tabs can simply be closed by pressing the X next to it. If the user closes a tab by accident and has edited something in there, the change will be lost.

We should add a dialog asking the user whether he wants to save, discard or cancel.

Editor doesn't appear if the last closed tab was in "view" mode.

Describe the bug
The editor doesn't appear if the last closed tab was in "view" mode.

Environment (please complete the following information):

  • v0.0.7

To Reproduce
Steps to reproduce the behavior:

  1. Start app
  2. Open an existing H5P
  3. Switch to edit mode and back to view
  4. Close the tab
  5. Create a new H5P

Add export option for H5P Standalone

Using H5P-content still requires a server component. H5P Standalone provides the missing libraries to make H5P self-contained and run without an explicit server. It would be convenient if Lumi provided an export option for this. Technically this would only mean adding certain static files, see our H5P-Creator). But maybe such a feature would interfere with Lumi.run (no offence intended)?

Switching from view to edit doesn't display editor fully

Describe the bug
The editor is only partially displayed (see screenshot).

Environment (please complete the following information):
v0.0.7

To Reproduce
Steps to reproduce the behavior:

  1. Open a file from the disk
  2. Click on "edit"

Screenshots
image

Default keyboard accelerators are not working (cmd+a,cmd+c,cmd+v)

Describe the bug
Default keyboard accelerators are not working (cmd+a,cmd+c,cmd+v), so if you want to select or copy text it won't work.

Environment (please complete the following information):

  • 0.1.0

Expected behavior
Text should be selectable by cmd+a and copied with cmd+c & cmd+v.

Additional context
This is most likely due to undefined electron accelerators.
Possible solution: https://medium.com/fantageek/supporting-copy-and-paste-in-electron-30bff250e564

How to start the development server

I don't understand how to start the development server to debug the application.

I've done this:

npm install
npm run build
npm start

The browser opens and loads http://localhost:3000. However, I then get the following errors:

Proxy error: Could not proxy request /static/js/bundle.js from localhost:3000 to http://localhost:3001/.
See https://nodejs.org/api/errors.html#errors_common_system_errors for more information (ECONNREFUSED).

Proxy error: Could not proxy request /static/js/0.chunk.js from localhost:3000 to http://localhost:3001/.
See https://nodejs.org/api/errors.html#errors_common_system_errors for more information (ECONNREFUSED).

Proxy error: Could not proxy request /static/js/main.chunk.js from localhost:3000 to http://localhost:3001/.
See https://nodejs.org/api/errors.html#errors_common_system_errors for more information (ECONNREFUSED).

How do I start the second (backend?) server on 3001?

File association in Windows

There currently is no file association for h5p files in Windows. This would be very neat.

This would require the installer to install for 'all users' and not only for the current user. It might be best to leave the choice up to the user, as we avoid the problem of requiring admin privileges.

Course Presentation editor: tooltip clipped

Describe the bug
In the editor of course presntation the tooltips are clipped in the overflow menu. I don't think this is an error in Joubel's client but has something to do with the custom renderer.

Environment (please complete the following information):

  • Lumi v0.07

Screenshots
image

Mathematical expressions in H5Ps

Is your feature request related to a problem? Please describe.
Lumi does not display mathematical expressions in LaTeX.

Describe the solution you'd like
Lumi should be able to display mathematical expressions.

According to https://h5p.org/mathematical-expressions we have to install the following library:
https://h5p.org/sites/default/files/h5p-math-display-1.0.5.h5p

I think @sr258 also had the idea of a library-management-section where the user can manage all libraries. That would be an ideal use case or we include that library right from the beginning.

npm / yarn install not working

yarn install
yarn install v1.21.1
info No lockfile found.
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.
[1/4] Resolving packages...
warning @commitlint/cli > babel-polyfill > [email protected]: core-js@<3 is no longer maintained and not recommended for usage due to the number of issues. Please, upgrade your dependencies to the actual version of core-js@3.
warning @commitlint/cli > babel-polyfill > babel-runtime > [email protected]: core-js@<3 is no longer maintained and not recommended for usage due to the number of issues. Please, upgrade your dependencies to the actual version of core-js@3.
warning @material-ui/core > [email protected]: You can find the new Popper v2 at @popperjs/core, this package is dedicated to the legacy v1
warning @types/[email protected]: This is a stub types definition for electron (https://github.com/electron/electron). electron provides its own type definitions, so you don't need @types/electron installed!
warning @types/[email protected]: This is a stub types definition for Moment (https://github.com/moment/moment). Moment provides its own type definitions, so you don't need @types/moment installed!
warning @types/[email protected]: This is a stub types definition. query-string provides its own type definitions, so you do not need this installed.
warning babel-jest > @jest/transform > jest-haste-map > sane > micromatch > snapdragon > source-map-resolve > [email protected]: https://github.com/lydell/resolve-url#deprecated
warning babel-jest > @jest/transform > jest-haste-map > sane > micromatch > snapdragon > source-map-resolve > [email protected]: Please see https://github.com/lydell/urix#deprecated
warning jest > jest-cli > jest-config > jest-environment-jsdom > jsdom > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning jest-environment-jsdom-fourteen > jsdom > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning resolve-url-loader > rework > css > [email protected]: Please see https://github.com/lydell/urix#deprecated
warning semantic-release > @semantic-release/npm > npm > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning semantic-release > @semantic-release/npm > npm > node-gyp > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning spectron > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning spectron > [email protected]: outdated version, please use @next
warning spectron > webdriverio > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning spectron > electron-chromedriver > electron-download > nugget > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
[2/4] Fetching packages...
error @semantic-release/[email protected]: The engine "node" is incompatible with this module. Expected version ">=10.18". Got "10.15.2"
error Found incompatible module.
info Visit 

also fails with npm

Outdated dependencies and lock file issues

Not all dependencies in package.json are updated by Renovate. Several are currently outdated, even though they are not major releases. @JPSchellenberg , I can update them manually, but I'd like to check with you whether they are pinned on purpose.

I also have had trouble running npm ci: Weirdly, there is always some file missing in node_modules after it. I want to regenerate package-lock.json for this purpose. Any concerns?

Large window width leads to problems in some content types (player)

Describe the bug
If the screen width is very high, the player uses the space. This leads to problems in some content types that don't really expect a width that high. This for example is true in Drag & Drop (see video below), but also in other content types. Portrait images that are enlarged by clicking on them become really big.

This is a problem that also occurs in the PHP implementation, if the screen width is high. Still, I think we should give it some thought, whether we can improve the situation somehow.

lumi-player-width4

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Title is not saved

Describe the bug
The title is not saved after changing/exporting the file.

Environment (please complete the following information):

  • all

To Reproduce
Steps to reproduce the behavior:

  1. Create a new H5P
  2. Change its title
  3. Save it

Expected behavior
The title in the Tab should be updated.

Full screen button in editor doesn't work as expected

Describe the bug
If you click on the full screen button in the editor of content types that support it (e.g. Course Presentation), you don't get a fullscreen view but the editing area is actually smaller than before.

Environment (please complete the following information):

  • Lumi v0.0.7

LeftDrawer should close when opening the crash-reporter

Describe the bug
The LeftDrawer is placed above the crash-report-dialog, so a part of the dialog is cut off.

Environment (please complete the following information):

  • all

To Reproduce
Steps to reproduce the behavior:

  1. Open the LeftDrawer
  2. Click on the bug-report button

Expected behavior
LeftDrawer should be closed when opening the crash-report-dialog.

Screenshots
Screenshot 2020-02-14 at 16 36 39

Lumi seems to be producing incomplete H5P-files in unknown constellations

I have learned about a person who had problems installing and using Lumi on Windows. Firstly, Chrome showed the hint that the installer was a suspicious file, which understandably irritated the person:

chrome

After installation, the saved H5P file was reproducibly incomplete. As far as I can tell, the H5P libraries in particular are missing. I attached one of the files saved with Lumi (renamed from h5p to zip to bypass the attachment restriction):

arithmeticquiz.zip

So it contains only two files:

h5p.json
content/content.json

Unfortunately I have no further information on the case, so I'm not sure if this is even suitable for further investigations. But at least it is documented as far as possible. Do you have an idea what this might be caused by?

CSS preview

To improve the integration of H5P content on your own website, it is important to have a consistent style with the rest of the content on the page.

H5P offers the possibility to use a custom CSS. It would be great if Lumi would accept a css file that would allow previewing the created content as it will appear on the website.

You can see an example in the screenshot below, where I adapted the font in the H5P content to be consistent with the table on the page.

css_h5p

Switching really fast between tabs makes the editor unresponsive

Describe the bug
Switching really fast between tabs makes the editor unresponsive (it doesn't load at all / it takes a very long time to load). I think this is because cancelling the loading process isn't a good idea.

Environment (please complete the following information):

  • v0.0.7
  • a rather slow Surface 3 (disk access is particularly slow)

Steps to reproduce:

  • load any file in a tab
  • create a new h5p
  • switch back and forth between the two tabs

Content type list from Hub not updating

Describe the bug
If you open the Hub list, you get the warning "Content type list outdated". Either the app can't reach the Hub (wrong endpoint? Not registered?) or the update is never called.

Environment (please complete the following information):

  • Lumi v0.0.7

Expected behavior
The error message doesn't appear.

Screenshots
image

npm ci on every branch change slows down development a lot

I understand the reasoning why Husky forces npm ci after every branch change, but I think this goes a bit too far currently:

Changing branches takes a long time now, as npm ci downloads a massive amount of data and creates thousands of files. Several of the dependencies can't be cached (Chrome download, H5P core data) and it takes several minutes to change a branch (and is sometimes not successful). My main development machine is really potent and things are still slow. I also have trouble pushing branches to GitHub (seems to take forever).

How about changing it to npm install?

Clicking on an external link opens the link

Describe the bug
If you click on an external link, electron opens that page and it is not possible to navigate back.

Environment (please complete the following information):

  • all

To Reproduce
Steps to reproduce the behavior:

  1. Click on crash-report-button
  2. Click on the Sentry-logo

Expected behavior
The app should not go to the external homepage.

Screenshots
Screenshot 2020-02-14 at 16 40 41

Package validation failed - file size too large

When trying to open a larger file (here: ~70MB), the error attached message file appears. Where is the upper limit and how can I increase it? If you embed a video, this limit is quickly reached.

filesize

Broken symlinks in macOS zip file release

If Lumi is installed on macOS (10.15.4) via the zip file from the releases page, Lumi cannot be started afterwards. At first glance this seems to be due to broken symlinks. In the Apple Disk Image the symlinks are intact and the installation works over there. I stumbled over it because the website doesn't always link the latest release, so I had loaded the broken zip file by mistake.

Bildschirmfoto 2020-05-05 um 14 28 36

Linux version behind macOS and Windows

Describe the bug
The Linux version is behind the macOS and Windows version. This is due to the fact that for a release semantic-release is run on the CI-Server for Windows and macOS. During the process, semantic-release checks the latest version, increments the number and writes it to the package.json and pushes it back to github. Then another Ubuntu-Environment is started where the Linux version is built. semantic-release is run here too, but the branch is out-dated because semantic-release pushed the updated package.json to github, therefore no release is created and the package.json for Linux is not updated.

Environment (please complete the following information):

  • CI

Possible solution

We could try to make package.json an artifact that is carried over to the ubuntu-environment. That way the version should already be updated.

Content width in player never changed

Describe the bug
If you open the player with content and later resize the window, the content width is not recalculated.

What I'd expect
The content is resized.

Screenshot
lumi-player-width

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch master on the remote Git repository with URL https://github.com/Lumieducation/Lumi.git.

This can be caused by:


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Clicking on "edit" lots of times breaks viewer

Describe the bug
Clicking on "edit" lots of times breaks viewer

Environment (please complete the following information):

  • v0.0.7

To Reproduce
Steps to reproduce the behavior:

  1. Open app
  2. Load file
  3. Click on edit
  4. Click on edit 20x very fast
  5. Click on view --> nothing happens

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Privacy Policy

Lumi needs a privacy policy to be listed in the Microsoft Store.

Missing images in H5P Dialog Cards created with Lumi

An added (optional) image to a Dialog card is displayed only in the editor, but not in view mode. In the source code of the content.json you can see that the width and height information for the image is missing. If I add them manually in code, the image will be displayed.

Bildschirmfoto 2020-05-05 um 13 06 29

Environment

  • macOS 10.15.4
  • Lumi 0.27

Broken:

  "dialogs": [{
    "tips": {},
    "image": {
      "path": "images/planung-9DG-IFl5p.jpg",
      "mime": "image/jpeg",

Fixed:

  "dialogs": [{
    "tips": {},
    "image": {
      "path": "images/planung-9DG-IFl5p.jpg",
      "mime": "image/jpeg",
      "width": 1920,
      "height": 1280,

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.