Release Date: August 24 2017 (pending better coded demo)

For Developers

All code is included inside app folder.
Rakefile in app folder contains the commands that run the program.
All other classes currently in app/src.

Why Github-Maps?

It started after looking at someones Repository on Github called "RandomPrograms". The repository consisted of subfolders and each subfolder having subfolders. A context was presented by this "RandomPrograms" repository; however, a user could not star and self organize the projects they appreciated.

The initial mission of the program is to go through each subfolder in that repository and convert it into a github map with subfolders becoming repositories - either on your account or an account with a moniker "Star" at the end of it. The user will be left with a map. Where projects can be accessed and a user is free to star what they enjoy.

The second part of the project is that most people have repositories correctly organized on Github. However, there is no context between projects. A quick look at github.com/google shows 961 repositories. But a user curious in finding something unique and not something popular to contribute toward would need to read all 961 repositories. Github-Maps solves this problem by allowing a repo to provide context for other repositories.

How to install.

install ruby ... #ruby instructions to be added.
bundle install rake


verify the install command: rake --version; ruby -v;

Run the demo?

git clone https://github.com/mapFactory/Github-Map.git
cd Github-Map/app
rake demo_github_map

Wait for program to complete then check github.com/miketestgit02 to ensure it created.

rake demo_de_github_map

Wait for program to complete then check github.com/miketestgit02 to ensure it deleted.

How to use.

Convert your repo with many subfolders into a map... with the subfolders as repo's

git clone https://github.com/mapFactory/Github-Map.git;
cd Github-Map/my_repositories;
git clone your_repository_name.git; 
                                   #... or, move folder in question into Github-Map/my_repositories
				   #... or mkdir's inside my repositories.
rake github_map

... we will clone the folder on the primary account input into the program.
and change the folder structure into a Github Map so that subfolders are made repos. And the organization
persists with the resultant repository having submodules to those previous subfolders.

rake de_Github_Map   #revert back

Make a map locally and we will build it for you.

... say you have a large number of repositories on github. But no context showing how repositories are related.
(0) make a directory... topmost folder what you would like to call the map... subfolders the repositories
online that fit into that classification.

rake Github_Map;     #build
rake de_Github_Map   #revert back