The MM repo has a git configuration to only track the “default” folder in the MM/modules folder. This is cool because you can have a separate git repository inside another! When you like a module someone (even yourself) created on github, you need to install it in the MM/modules folder. For example, from the MagicMirror/modules directory, I’m cloning a repo:

[MagicMirror/modules]> git clone https://github.com/sdetweil/MyCovid19.git

You’ll see that a new directory is created under the “modules” directory – and it’s the same name as the git repository. Important to this discussion; the MagicMirror repo doesn’t care about this new directory! You follow the usual steps to update MM with no git side-effects … and … you can update the new module directory that you cloned using the same “git pull” process!

Side note: there are often a few more steps needed to install a module. In this example, @sdetweil follows best practice to include installation instructions in the module README.

So, in a general case, you can create a repo, for example, “MyStuff” in the MM/modules folder. It can contain anything and you can manage it (edit files/push/pull/branch/etc.) all within the “MM/modules/MyStuff” directory.

Just don’t call your repository “default”! :-b

fyi - Git keeps track of files/directories to ignore within a repository by using a .gitignore file located in the repo’s root folder. Check out all the files the MagicMirror ignores!

Just thought I’d mention MagicMirror has a config check command. It helps me find missing commas, failed close parenthesis, etc.

In your MagicMirror directory:

npm run config:check

@bhepler Another cloud host option is google, who offers a free tier as well.

my universal caveat – As with all “free” things, TANSTAAFL

@blacter If you have interest/time … the VS Code editor runs on macOS and has a nice ‘remote ssh’ functionality to edit files remotely. While it has a lot of “programmer” functions, it’s not a bad editor to help anyone. (And this, from a guy who prefers a command line.)

@blacter If you have interest/time … the VS Code editor runs on macOS and has a nice ‘remote ssh’ functionality to edit files remotely. While it has a lot of “programmer” functions, it’s not a bad editor to help anyone. (And this, from a guy who prefers a command line.)

@karsten13 You are correct that a parent /mm/ repository could nicely include the MagicMirror/config/config.js file while excluding the ‘core’ MagicMirror! :clapping_hands_medium-light_skin_tone:

Minor thoughts:

1. Using your suggested command in that parent /mm/ repository,

   git add -f MagicMirror/modules/*
   

   … will include the modules/default/ directory.
   Since it is included by the MagicMirror repository. I suggest only adding the specific paths to any modules you have edited.
2. also add the .gitignore to the parent /mm/ repository.

@karsten13 Git supports nested repositories. No need to create a higher level repo and then ignore the MagicMirror. There’s already a line in the MagicMirror/.gitignore

# Ignore all modules except the default modules.
/modules/**

So anything can be created in the MagicMirror/modules directory – and it is ignored by the MM repo.

The MM repo has a git configuration to only track the “default” folder in the MM/modules folder. This is cool because you can have a separate git repository inside another! When you like a module someone (even yourself) created on github, you need to install it in the MM/modules folder. For example, from the MagicMirror/modules directory, I’m cloning a repo:

[MagicMirror/modules]> git clone https://github.com/sdetweil/MyCovid19.git

You’ll see that a new directory is created under the “modules” directory – and it’s the same name as the git repository. Important to this discussion; the MagicMirror repo doesn’t care about this new directory! You follow the usual steps to update MM with no git side-effects … and … you can update the new module directory that you cloned using the same “git pull” process!

Side note: there are often a few more steps needed to install a module. In this example, @sdetweil follows best practice to include installation instructions in the module README.

So, in a general case, you can create a repo, for example, “MyStuff” in the MM/modules folder. It can contain anything and you can manage it (edit files/push/pull/branch/etc.) all within the “MM/modules/MyStuff” directory.

Just don’t call your repository “default”! :-b

fyi - Git keeps track of files/directories to ignore within a repository by using a .gitignore file located in the repo’s root folder. Check out all the files the MagicMirror ignores!

@sdetweil This is solid gold :shooting_star: for the Windoz user in me! With these finishing steps, it works as expected. Thanks again!
p.s. bonus points for suggesting notepad for editing the package.json along with the steps to quit nodepad… Too funny!

@Sean – many people have enjoyed your hard work. THANK YOU. You should be proud of what you’ve accomplished in giving so much to this community. I hope you find some peace and rest in this very difficult time in your life. Very best wishes and again, thanks!

When I heard about this, my first thought was of my PiHole and all of the internet ads going into oblivion! (It’s running on the same Pi I use for my MM playground.)

@bhepler Another cloud host option is google, who offers a free tier as well.

my universal caveat – As with all “free” things, TANSTAAFL

I’d try to help, but I don’t know how to make use of the referenced pull request. (aka I’m a git newb …) Do I pull a new copy of the entire MM project into a different directory and then do a ‘pull/merge’ of the pull request? I could you a little assistance on the nuances of using git to support this with some testing.

Just thought I’d mention MagicMirror has a config check command. It helps me find missing commas, failed close parenthesis, etc.

In your MagicMirror directory:

npm run config:check