Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Website for generating configs & dependencies #928

Open
tobi-wan-kenobi opened this issue Sep 17, 2022 · 14 comments
Open

Website for generating configs & dependencies #928

tobi-wan-kenobi opened this issue Sep 17, 2022 · 14 comments
Assignees

Comments

@tobi-wan-kenobi
Copy link
Owner

Feature Request

Idea from #922 by @HappyCthulhu

Create a website that allows users to generate configs & lists required dependencies. Bonus points for making the website so that it also works nicely via curl, similar to curl cheat.sh/psql

@Sushants-Git
Copy link

Demo :

simplescreenrecorder-2023-12-26_16.31.07.mp4

Site : https://bumblebee-status-config-gen.netlify.app/

(At the moment it works for "cpu, date, datetime, debug, disk, error, git, keys, layout, load, memory " )

Hey @tobi-wan-kenobi ,

Have been using bumblebee-status for a long time now and wanted to contribute to the project.

Made this small demo of my interpretation of the website currently works for "cpu, date, datetime, debug, disk, error, git, keys, layout, load, memory ". it generates a config and also shows the required dependencies ( I can also sort them into python and non-python packages ).

Before proceeding, I'd appreciate your feedback.

Would you like for me to make any specific changes? Please let me know your thoughts.

Thanks!

@tobi-wan-kenobi
Copy link
Owner Author

This looks awesome, many thanks! I will have to think feedback through in detail, but overall, I like the direction this takes a lot.

Thank you!

@Sushants-Git
Copy link

Feel free to take your time, when you have the details sorted let me know!!

Feel free to assign this issue to me.

@tobi-wan-kenobi
Copy link
Owner Author

OK, so I guess I am missing something really obvious, but I cannot make a second input appear for a second module (Firefox, Chrome).

But from your video, this looks awesome!

@Sushants-Git
Copy link

Sushants-Git commented Dec 27, 2023

Can you do "cpu < Press Space > memory < Press Space >" make sure that everything is in lowercase and if the error continues can you send me a small recording of it.

@tobi-wan-kenobi
Copy link
Owner Author

Aahhh, that works, I was sure I was missing something. Thanks!

Maybe a hint on the page would be good? ("Modules (space separated):")

I like this a lot in the current form already, my personal suggestions going forward would be:

  • enable direct copy/paste (remove parameters and theme instead of placeholders)
  • theme drop-down

Not sure how feasible, but anlive preview would be a supercool stretch goal.

But even if you don't change a single thing, this is cool and absolutely deserves to go in the docs.

Thank you!

@Sushants-Git
Copy link

Sushants-Git commented Dec 27, 2023

Thanks a lot for the kind words,

  • Will add the ("Modules (space separated):") hint or will find a way to make it obvious
  • Will enable direct copy/paste, and if the theme and other parameters are left empty i will remove them from the copy
  • Will add a theme drop down

By a live preview do you mean showing the bumblebee-status itself, that would be a dope side quest on it's own. (Will try to do this after i get all the modules added first)

One more thing do you have any array like data that you use for the docs website bcs. this is how right now i am storing the data ( https://github.com/Sushants-Git/Bumblebee-Status-Config-Gen/blob/main/src/components/data.js ), it will make the things a lot easier if you already have something like this.

Even if you don't that's nothing to worry about, i can always do it manually.

I will continue working on this and will give you an update by 31 Dec 2023.

Thank you!!

tobi-wan-kenobi added a commit that referenced this issue Dec 28, 2023
@Sushants-Git
Copy link

Sushants-Git commented Dec 31, 2023

  • Added all the modules
  • Added the theme drop down
  • Added the copy button (It will ignore the placeholders text)

just need to add the ("Modules (space separated):") hint

Link : https://bumblebee-status-config-gen.netlify.app/

let me know your thoughts and feel free to suggest any changes.

Thanks a lot for adding this to the docs.

@tobi-wan-kenobi
Copy link
Owner Author

Awesome, many thanks! This is truly great, I added it to the docs already (with attribution, please let menknow if you want something changed)

@Sushants-Git
Copy link

Thanks a lot for adding it to the docs.

I am currently adding some more changes to the website, these are just minor changes like :

  • Adding Contributors name for the contrib modules and links to there github
  • Giving dependencies diff. colors for python, executable, unknown packages
  • Live search bar for like when user presses c he should see all the modules that start with c and if they press cp all the modules that start with cp
  • Showing the image of the selected theme

After i make these changes (will take me about a week) feel free to close this issue

@tobi-wan-kenobi
Copy link
Owner Author

Woah, those are great ideas, thanks!

@Sushants-Git
Copy link

Sushants-Git commented Jan 2, 2024

Added all the above functionalities, let me know if you want me to make any changes.

  • Contributors names
  • Search bar autocomplete
  • dependencies diff. colors
  • Images of the Selected theme

If there are no more changes to make feel free to close this issue.

@ahormann
Copy link

ahormann commented Jan 23, 2024

This looks great!
I think it would be helpful if it would list ALL required packages.
eg. tkinter is currently not listed as dependency for pulsectl. It is not required for the module to work, but for the optional popups.

Furthermore pulsectl is a tricky module, you cannot use it directly, but pulsein and pulseout instead. This is currently not reflected by this website.

And it would be a cherry on top to generate install-commands for required packages for different systems (eg a pacman-command and a pip command). But this would probably require a lot of effort / community work given the amount of different package managers.

@Sushants-Git
Copy link

Those are some pretty good suggestions @ahormann.

The config. generation website itself is open source ( https://github.com/Sushants-Git/Bumblebee-Status-Config-Gen ), if you want to add some packages for a specific module you can make changes in src > components > data.js in the modulesData variable and create a pull request.

I will try and figure out a way to make this easier since not everyone wants to create a pull request for making a small change, will try to add something to the website that allows people to request changes and packages to be added like a mini form or something.

Thanks a lot for the suggestions!!

mihaimorariu pushed a commit to mihaimorariu/bumblebee-status that referenced this issue May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants