Skip to content

Aranyalma2/elfinConnectWeb

Repository files navigation

Elfin Connect WebUI

Development version Latest release Github top language Codacy qualty Repository size License


🎯 About

  • Elfin Connect service Web UI, not a standalone application, for basic functionalities, must have a MongoDB connection. It will use multiple documents for general data and files (with GridFS).
  • For full functionality, you have to run Elfin Connect Server. This service will create most of the data that is accessible and manageable from the WebUI.

🏁 First login

After a full application deployment, for the first login, you have to set up and create a profile with the highest privileges.

  1. Load setup page.
https://your-domain.com/setup
  1. Create a profile and login with it.

Setup page will be disabled after a valid user created and leave the page.

Basic functionalities

Home page

Availability statistics of devices.

User Page

User's attributums, uuid, elfin strings. Change password.

Devices

User's devices. List them, able to sorting them, and delete. Page will auto reload every 60 seconds.

Downloads

Administrators able to upload files. Users can download them. Default sorting by upload date.

Register

Administrators able to register new users

Extra functionalities

  • change language (en/hu)

📃 Upcoming Features

  • ⚙️ proper mobile view
  • 📌after beta testing phase: public registration
  • 💡 news page
  • ⚙️has to accept the new devices
  • 💡 create and manage groups for devices
  • 💡 able to share a device with other profiles (grant and remove access)
  • 💡 categorize the download center
  • 💡 able to add third-party links to e download center (github release)

💉 For commiters

🏭 Run tests and code coverage with

npm test

🚩 Run Prettier before commit

Run prettier before all of your commits, please. CI pipeline does not in action yet.

npx prettier . --write

📝 License

This project is under license from Apache 2.0. For more details, see the LICENSE file.

Made with ❤️ by Aranyalma2

 

Back to top